rspec/rules/S2854/python/rule.adoc

55 lines
1.3 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
Unlike class and instance methods, static methods don't receive an implicit first argument. Nonetheless naming the first argument ``++self++`` or ``++cls++`` guarantees confusion - either on the part of the original author, who may never understand why the arguments don't hold the values he expected, or on that of future maintainers.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2021-04-28 16:49:39 +02:00
----
class MyClass:
@staticmethod
def s_meth(self, arg1, arg2): #Noncompliant
# ...
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2021-04-28 16:49:39 +02:00
----
class MyClass:
@staticmethod
def s_meth(arg1, arg2): #Noncompliant
# ...
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Remove the "xxx" argument from this method definition.
'''
== Comments And Links
(visible only on this page)
=== is duplicated by: S2851
=== is duplicated by: S2852
=== on 24 Apr 2015, 09:04:19 Elena Vilchik wrote:
\[~ann.campbell.2] I would replace ``++bug++`` tag with ``++confusing++``. Or at least add it. WDYT?
=== on 28 Apr 2015, 15:36:24 Ann Campbell wrote:
\[~elena.vilchik] I've downgraded this from bug to pitfall (meaning it's not broken now but you've left a trap for the next guy)
endif::env-github,rspecator-view[]