Confusing naming of struct fields or methods RVV-B0001
Bug risk
Minor
6 months ago
—
6 months old
Method 'decode' differs only by capitalization to function 'Decode' in the same source file
181
182// Detect playlist type and decode it. May be used as decoder for both
183// master and media playlists.
184func decode(buf *bytes.Buffer, strict bool, customDecoders []CustomDecoder) (Playlist, ListType, error) {185 var eof bool
186 var line string
187 var master *MasterPlaylistMethod 'decode' differs only by capitalization to method 'Decode' in the same source file
114 return p
115}
116
117func (p *MediaPlaylist) decode(buf *bytes.Buffer, strict bool) error {118 var eof bool
119 var line string
120 var err errorMethod 'decode' differs only by capitalization to method 'Decode' in the same source file
61}
62
63// Parse master playlist. Internal function.
64func (p *MasterPlaylist) decode(buf *bytes.Buffer, strict bool) error { 65 var eof bool
66
67 state := new(decodingState)
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
}