Confusing naming of struct fields or methods RVV-B0001
Bug risk
Minor
2 months ago
—
3 years old
Method 'deployMachinesApp' differs only by capitalization to method 'DeployMachinesApp' in the same source file
278// - Remove spare machines from removed groups
279// - Launch new machines on new groups
280// - Update existing machines
281func (md *machineDeployment) deployMachinesApp(ctx context.Context) error { 282 ctx, span := tracing.GetTracer().Start(ctx, "deploy_new_machines")
283 defer span.End()
284
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
}