rspec/rules/S1845/python/rule.adoc
2020-12-23 14:59:06 +01:00

22 lines
801 B
Plaintext

Looking at the set of methods and fields in a ``class`` and finding two that differ only by capitalization is confusing to users of the class.
This situation may simply indicate poor naming. Method names should be action-oriented, and thus contain a verb, which is unlikely in the case where both a method and a field have the same name (with or without capitalization differences). However, renaming a public method could be disruptive to callers. Therefore renaming the member is the recommended action.
== Noncompliant Code Example
----
class SomeClass:
lookUp = false
def lookup(): # Non-compliant; method name differs from field name only by capitalization
pass
----
== Compliant Solution
----
class SomeClass:
lookUp = false
def getLookUp():
pass
----