aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSon Luong Ngoc <sluongng@gmail.com>2023-05-16 06:45:47 +0200
committerGitHub <noreply@github.com>2023-05-15 21:45:47 -0700
commit8eab992ae0e07ee73643d5659a406ccfc3766483 (patch)
tree1e8c752ad766c7ba8455784df6cf72de551f6603
parentc403db655ff4db63101ea8f4e7f1aa7b46dd73ee (diff)
downloadbazelbuild-rules_go-8eab992ae0e07ee73643d5659a406ccfc3766483.tar.gz
Fix formatting in nogo usage doc (#3557)
-rw-r--r--go/nogo.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/go/nogo.rst b/go/nogo.rst
index c6f65f51..7e3183cd 100644
--- a/go/nogo.rst
+++ b/go/nogo.rst
@@ -136,9 +136,13 @@ Relationship with other linters
~~~~~~~~~~~~~~~~~~~~~
In Golang, a linter is composed of multiple parts:
+
- A collection of rules (checks) that define different validations against the source code
+
- Optionally, each rules could be coupled with a fixer that can automatically fix the code.
+
- A configuration framework that allows users to enable/disable rules, and configure the rules.
+
- A runner binary that orchestrate the above components.
To help with the above, Go provides a framework called `analysis`_ that allows