Why this matters
Required for accurate godoc output and discoverability.
Every package must have a package comment, and each exported identifier must have a comment starting with the identifier name and a full-sentence summary.
Required for accurate godoc output and discoverability.
Side-by-side examples engineers can pattern-match during review.
// utils
package utils
func Hash(s string) string { ... }// Package utils provides helper functions for hashing and encoding.
package utils
// Hash returns a SHA-256 hex digest of s.
func Hash(s string) string { ... }// Parse parses an ISO8601 timestamp.
func Parse(s string) (time.Time, error) { ... }// parses time
func Parse(s string) (time.Time, error) { ... }From the same buckets as this rule.