Confusing naming of struct fields or methods RVV-B0001
Bug risk
Minor
6 months ago
—
a year old
Method 'listener' differs only by capitalization to function 'Listener' in the same source file
7
8func Listener(port string) net.Listener { return listener(port) }
9
10func listener(p string) net.Listener {11 ln, err := net.Listen("tcp", p)
12 if err != nil {
13 log.Fatalln(err)Method 'Fill' differs only by capitalization to method 'fill' in the same source file
929 }
930}
931
932func (w *LightWindow) Fill(text string) FillReturn {933 w.Move(w.posy, w.posx)
934 w.setBg()
935 return w.fill(text, w.setBg)Method 'ParseOptions' differs only by capitalization to function 'parseOptions' in the same source file
1396}
1397
1398// ParseOptions parses command-line options
1399func ParseOptions(args []string, options ...Opt) *Options {1400 opts := defaultOptions()
1401
1402 // Options from Env var
Description
Methods or fields of struct that have names different only by capitalization could be confusing.
Bad practice
type SomeType struct {
// actual build system to be inferred, based on the `BuildSystem` passed by user
buildSystem string
// name of the build system to use
BuildSystem string
}
Recommended
type SomeType struct {
// actual build system to be inferred, based on the `BuildSystem` passed by user
internalBuildSystem string
// name of the build system to use
BuildSystem string
}