ST1021: handle type names that are also articles

Closes gh-1187
dominikh · Apr 23, 2022 · 416f0a8 · 416f0a8
1 parent 971b654
commit 416f0a8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/stylecheck/lint.go b/stylecheck/lint.go
@@ -875,6 +875,11 @@ func CheckExportedTypeDocs(pass *analysis.Pass) (interface{}, error) {
 				}
 			}
 
+			// Check comment before we strip articles in case the type's name is an article.
+			if strings.HasPrefix(text, node.Name.Name+" ") {
+				return false
+			}
+
 			s := text
 			articles := [...]string{"A", "An", "The"}
 			for _, a := range articles {

diff --git a/stylecheck/testdata/src/CheckExportedTypeDocs/CheckExportedTypeDocs.go b/stylecheck/testdata/src/CheckExportedTypeDocs/CheckExportedTypeDocs.go
@@ -55,3 +55,6 @@ type T13 struct{}
 //some:directive //@ diag(`comment on exported type`)
 // Whatever
 type T14 struct{}
+
+// A does stuff.
+type A struct{}