51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
54 lines
890 B
Plaintext
54 lines
890 B
Plaintext
== Why is this an issue?
|
|
|
|
Shared naming conventions allow teams to collaborate efficiently.
|
|
|
|
This rule raises an issue when a method name does not match a provided regular expression.
|
|
|
|
For example, with the default provided regular expression ``++^[a-z_][a-z0-9_]*$++``, the method:
|
|
|
|
[source,python]
|
|
----
|
|
class MyClass:
|
|
def MyMethod(a,b): # Noncompliant
|
|
...
|
|
----
|
|
|
|
should be renamed to
|
|
|
|
[source,python]
|
|
----
|
|
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[]
|