diff options
| author | Steven M. Vascellaro <svascellaro@gmail.com> | 2018-07-03 15:59:47 -0400 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2018-07-03 21:59:47 +0200 |
| commit | 66f3f3d34959a6b63d5cdb950e1fcbde6c34a053 (patch) | |
| tree | 3914e1eddfc7989e44e959121ede7984c3580ef6 | |
| parent | 7a8380fabd7d8ddbe2622a5314316bed2e9a77f3 (diff) | |
| download | pylint-git-66f3f3d34959a6b63d5cdb950e1fcbde6c34a053.tar.gz | |
Add docstrings for naming style classes (#2245)
Add docstrings for SnakeCaseStyle, CamelCaseStyle, PascalCaseStyle, and UpperCaseStyle
| -rw-r--r-- | pylint/checkers/base.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/pylint/checkers/base.py b/pylint/checkers/base.py index f01b083fc..215c8724e 100644 --- a/pylint/checkers/base.py +++ b/pylint/checkers/base.py @@ -77,6 +77,7 @@ class NamingStyle: class SnakeCaseStyle(NamingStyle): + """Regex rules for snake_case naming style.""" CLASS_NAME_RGX = re.compile('[a-z_][a-z0-9_]+$') MOD_NAME_RGX = re.compile('([a-z_][a-z0-9_]*)$') CONST_NAME_RGX = re.compile('(([a-z_][a-z0-9_]*)|(__.*__))$') @@ -86,6 +87,7 @@ class SnakeCaseStyle(NamingStyle): class CamelCaseStyle(NamingStyle): + """Regex rules for camelCase naming style.""" CLASS_NAME_RGX = re.compile('[a-z_][a-zA-Z0-9]+$') MOD_NAME_RGX = re.compile('([a-z_][a-zA-Z0-9]*)$') CONST_NAME_RGX = re.compile('(([a-z_][A-Za-z0-9]*)|(__.*__))$') @@ -95,6 +97,7 @@ class CamelCaseStyle(NamingStyle): class PascalCaseStyle(NamingStyle): + """Regex rules for PascalCase naming style.""" CLASS_NAME_RGX = re.compile('[A-Z_][a-zA-Z0-9]+$') MOD_NAME_RGX = re.compile('[A-Z_][a-zA-Z0-9]+$') CONST_NAME_RGX = re.compile('(([A-Z_][A-Za-z0-9]*)|(__.*__))$') @@ -104,6 +107,7 @@ class PascalCaseStyle(NamingStyle): class UpperCaseStyle(NamingStyle): + """Regex rules for UPPER_CASE naming style.""" CLASS_NAME_RGX = re.compile('[A-Z_][A-Z0-9_]+$') MOD_NAME_RGX = re.compile('[A-Z_][A-Z0-9_]+$') CONST_NAME_RGX = re.compile('(([A-Z_][A-Z0-9_]*)|(__.*__))$') |