Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix function comments based on best practices from Effective Go #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix function comments based on best practices from Effective Go #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ var goVersionRegexp = regexp.MustCompile(`^go1(?:\.(\d+))?`)
// in order to be able to sort an array of Tag
type TagSlice []Tag

// Return the len of the array
// Len returns the len of the array
func (t TagSlice) Len() int {
return len(t)
}

// Compare two elements of a tag array
// Less compares two elements of a tag array
func (t TagSlice) Less(i, j int) bool {
return t[i].String() < t[j].String()
}
Expand Down
2 changes: 1 addition & 1 deletion tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func NewTag(name, file string, line int, tagType TagType) Tag {
}
}

// The tags file format string representation of this tag.
// String: The tags file format string representation of this tag.
func (t Tag) String() string {
var b bytes.Buffer

Expand Down