Respect the linter

Author: Юрий Лосев

cmd/generator.go

@@ -17,12 +17,12 @@ func main() {
 	generateDict()
 }
 
-type Row struct {
+type row struct {
 	Name string `json:"Name"`
 	Sex  string `json:"Sex"`
 }
 
-type NamesDict []Row
+type namesDict []row
 
 func generateDict() {
 	f, err := ioutil.ReadFile("cmd/russian_names.json")
@@ -32,7 +32,7 @@ func generateDict() {
 
 	f = bytes.TrimPrefix(f, []byte("\xef\xbb\xbf")) // отпилить BOM
 
-	var rows NamesDict
+	var rows namesDict
 
 	err = json.Unmarshal(f, &rows)
 	if err != nil {
@@ -48,6 +48,7 @@ func generateDict() {
 
 	_, _ = fmt.Fprint(out, "// DO NOT EDIT!\n// Code generated from cmd/generator.go\n\npackage rules\n\n")
 
+	fmt.Fprint(out, "// AllNames presents dictionary of firstnames for fallback\n")
 	fmt.Fprint(out, "var AllNames = map[string]Gender{\n")
 
 	for _, row := range rows {
@@ -91,6 +92,7 @@ func generateRules() {
 
 	_, _ = fmt.Fprint(out, "// DO NOT EDIT!\n// Code generated from cmd/generator.go\n\npackage rules\n\n")
 
+	fmt.Fprint(out, "// AllRules presents all geenerated petrovich rules\n")
 	fmt.Fprint(out, "var AllRules = Rules{\n\tFirstname: RulesGroup{\n")
 	printRulesGroup(out, petrovich.Firstname)
 

example_test.go

@@ -34,13 +34,12 @@ func ExampleTransform() {
 
 	for _, p := range people {
 		fmt.Println(petrovich.Transform(p, petrovich.Dative))
-		// Output:
-		// Прокопенко Сергею Ивановичу
-		// Николаеву Андрею Павловичу
-		// Морозовой Екатерине Алексеевне
-		// Павловой Антонине Сергеевне
-
 	}
+	// Output:
+	// Прокопенко Сергею Ивановичу
+	// Николаеву Андрею Павловичу
+	// Морозовой Екатерине Алексеевне
+	// Павловой Антонине Сергеевне
 }
 
 func ExampleTransformShort() {
@@ -72,10 +71,10 @@ func ExampleTransformShort() {
 	for _, p := range people {
 		newp := petrovich.Transform(p, petrovich.Instrumental)
 		fmt.Println(newp.Short())
-		// Output:
-		// Прокопенко С.И.
-		// Николаевым А.П.
-		// Морозовой Е.А.
-		// Павловой А.С.
 	}
+	// Output:
+	// Прокопенко С.И.
+	// Николаевым А.П.
+	// Морозовой Е.А.
+	// Павловой А.С.
 }

petrovich.go

@@ -11,18 +11,22 @@ import (
 //go:generate git submodule update --recursive --remote
 //go:generate go run cmd/generator.go
 
-// Gender specify Person`s gender - Male, Female, Androgynous
+// Gender specifies Person`s gender - Male, Female, Androgynous
 type Gender = rules.Gender
 
-// Case grammatical case (падежи)
+// Case specifies grammatical case (падежи)
 type Case = rules.Case
 
 const (
+	// Androgynous gender
 	Androgynous = rules.Androgynous
-	Male        = rules.Male
-	Female      = rules.Female
+	// Male gender
+	Male = rules.Male
+	// Female gender
+	Female = rules.Female
+
+	// cases
 
-	// case
 	// Nominative именительный
 	Nominative = rules.Nominative
 	// Genitive родительный

rules/gender.go

@@ -6,7 +6,10 @@ package rules
 type Gender int8
 
 const (
+	// Androgynous gender
 	Androgynous Gender = iota
+	// Male gender
 	Male
+	// Female gender
 	Female
 )

rules/rules.go

@@ -1,19 +1,24 @@
 package rules
 
+// For generation
+
+// Rule for petrovich-rules generation
 type Rule struct {
 	Gender Gender
 	Test   []string
 	Mods   []string
 }
 
+// RulesSet set of generated rules
 type RulesSet []Rule
 
+// RulesGroup group of rules
 type RulesGroup struct {
 	Exceptions RulesSet
 	Suffixes   RulesSet
 }
 
-// верхний уровень
+// Rules top level petrovich-rules
 type Rules struct {
 	Lastname   RulesGroup
 	Firstname  RulesGroup