rspec/rules/S100/python/rule.adoc

54 lines
890 B
Plaintext
Raw Normal View History

== Why is this an issue?
2023-06-06 17:27:22 +02:00
Shared naming conventions allow teams to collaborate efficiently.
2020-06-30 10:16:44 +02:00
2023-06-06 17:27:22 +02:00
This rule raises an issue when a method name does not match a provided regular expression.
2020-06-30 10:16:44 +02:00
2023-06-06 17:27:22 +02:00
For example, with the default provided regular expression ``++^[a-z_][a-z0-9_]*$++``, the method:
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 10:16:44 +02:00
----
class MyClass:
2023-06-06 17:27:22 +02:00
def MyMethod(a,b): # Noncompliant
2020-06-30 10:16:44 +02:00
...
----
2023-06-06 17:27:22 +02:00
should be renamed to
2020-06-30 10:16:44 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 10:16:44 +02:00
----
class MyClass:
def my_method(a,b):
...
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.format
****
_STRING_
----
^[a-z_][a-z0-9_]*$
----
Regular expression used to check the [method|function|subroutine] names against
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]