rspec/rules/S100/python/rule.adoc

== Why is this an issue?

Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate. This rule allows to check that all method names match a provided regular expression.

=== Noncompliant code example

With default provided regular expression: ``++^[a-z_][a-z0-9_]*$++``

[source,python]
----
class MyClass:
    def MyMethod(a,b):
        ...
----

=== Compliant solution

[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[]