2023-05-03 11:06:20 +02:00
|
|
|
== 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:
|
2020-06-30 14:49:38 +02:00
|
|
|
|
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):
|
|
|
|
...
|
|
|
|
----
|
2021-06-02 20:44:38 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../message.adoc[]
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
=== Parameters
|
|
|
|
|
|
|
|
.format
|
|
|
|
****
|
|
|
|
_STRING_
|
|
|
|
|
|
|
|
----
|
|
|
|
^[a-z_][a-z0-9_]*$
|
|
|
|
----
|
|
|
|
|
|
|
|
Regular expression used to check the [method|function|subroutine] names against
|
|
|
|
****
|
|
|
|
|
2021-09-20 15:38:42 +02:00
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2021-06-02 20:44:38 +02:00
|
|
|
== Comments And Links
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../comments-and-links.adoc[]
|
2023-06-22 10:38:01 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|