Add comments.

tetafro · Oct 26, 2020 · 3d59659 · 3d59659
1 parent 5672ba3
commit 3d59659
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/checks.go b/checks.go
@@ -186,6 +186,9 @@ func checkPeriod(comment string) (pos position, ok bool) {
 // NOTE: First letter is not checked in declaration comments, because they
 // can describe unexported functions, which start from small letter.
 func checkCapital(comment string, skipFirst bool) (pp []position) {
+	// List of states during the scan: `empty` - nothing special,
+	// `endChar` - found one of sentence ending chars (.!?),
+	// `endOfSentence` - found `endChar`, and then space or newline.
 	const empty, endChar, endOfSentence = 1, 2, 3
 
 	pos := position{line: 1}