Commit 431bc22a by Jesse Zoldak

By default, for edx projects do not require docstrings for private methods

parent 4fc893ad
...@@ -411,7 +411,7 @@ bad-names=foo,bar,baz,toto,tutu,tata ...@@ -411,7 +411,7 @@ bad-names=foo,bar,baz,toto,tutu,tata
# Regular expression which should only match function or class names that do # Regular expression which should only match function or class names that do
# not require a docstring. # not require a docstring.
no-docstring-rgx=__.*__$|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$ no-docstring-rgx=^_|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$
# Minimum line length for functions/classes that require docstrings, shorter # Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt. # ones are exempt.
......
...@@ -59,9 +59,10 @@ load-plugins = edx_lint.pylint ...@@ -59,9 +59,10 @@ load-plugins = edx_lint.pylint
[MESSAGES CONTROL] [MESSAGES CONTROL]
enable = enable =
# These are controlled by explicit choices in the pylintrc files
blacklisted-name, blacklisted-name,
line-too-long, line-too-long,
# These affect the correctness of the code
syntax-error, syntax-error,
init-is-generator, init-is-generator,
return-in-init, return-in-init,
...@@ -184,7 +185,7 @@ enable = ...@@ -184,7 +185,7 @@ enable =
anomalous-unicode-escape-in-string, anomalous-unicode-escape-in-string,
bad-open-mode, bad-open-mode,
boolean-datetime, boolean-datetime,
# Checking failed for some reason
fatal, fatal,
astroid-error, astroid-error,
parse-error, parse-error,
...@@ -192,20 +193,21 @@ enable = ...@@ -192,20 +193,21 @@ enable =
django-not-available, django-not-available,
raw-checker-failed, raw-checker-failed,
django-not-available-placeholder, django-not-available-placeholder,
# Documentation is important
empty-docstring, empty-docstring,
invalid-characters-in-docstring, invalid-characters-in-docstring,
missing-docstring, missing-docstring,
wrong-spelling-in-comment, wrong-spelling-in-comment,
wrong-spelling-in-docstring, wrong-spelling-in-docstring,
# Unused code should be deleted
unused-import, unused-import,
unused-variable, unused-variable,
unused-argument, unused-argument,
# These are dangerous!
exec-used, exec-used,
eval-used, eval-used,
# These represent idiomatic python. Not adhering to them
# will raise red flags with future readers.
bad-classmethod-argument, bad-classmethod-argument,
bad-mcs-classmethod-argument, bad-mcs-classmethod-argument,
bad-mcs-method-argument, bad-mcs-method-argument,
...@@ -240,32 +242,34 @@ enable = ...@@ -240,32 +242,34 @@ enable =
model-has-unicode, model-has-unicode,
model-no-explicit-unicode, model-no-explicit-unicode,
protected-access, protected-access,
# Don't use things that are deprecated
deprecated-module, deprecated-module,
deprecated-method, deprecated-method,
# These help manage code complexity
too-many-nested-blocks, too-many-nested-blocks,
too-many-statements, too-many-statements,
too-many-boolean-expressions, too-many-boolean-expressions,
# Consistent import order makes finding where code is
# imported from easier
ungrouped-imports, ungrouped-imports,
wrong-import-order, wrong-import-order,
wrong-import-position, wrong-import-position,
wildcard-import, wildcard-import,
# These should be auto-fixed by any competent editor
missing-final-newline, missing-final-newline,
mixed-line-endings, mixed-line-endings,
trailing-newlines, trailing-newlines,
trailing-whitespace, trailing-whitespace,
unexpected-line-ending-format, unexpected-line-ending-format,
mixed-indentation, mixed-indentation,
# These attempt to limit pylint line-noise
bad-option-value, bad-option-value,
unrecognized-inline-option, unrecognized-inline-option,
useless-suppression, useless-suppression,
bad-inline-option, bad-inline-option,
deprecated-pragma, deprecated-pragma,
disable = disable =
# These should be left to the discretion of the reviewer
bad-continuation, bad-continuation,
invalid-name, invalid-name,
misplaced-comparison-constant, misplaced-comparison-constant,
...@@ -275,7 +279,7 @@ disable = ...@@ -275,7 +279,7 @@ disable =
unused-wildcard-import, unused-wildcard-import,
global-statement, global-statement,
no-else-return, no-else-return,
# These are disabled by pylint by default
apply-builtin, apply-builtin,
backtick, backtick,
basestring-builtin, basestring-builtin,
...@@ -362,7 +366,7 @@ class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ ...@@ -362,7 +366,7 @@ class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$ inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$
good-names = f,i,j,k,db,ex,Run,_,__ good-names = f,i,j,k,db,ex,Run,_,__
bad-names = foo,bar,baz,toto,tutu,tata bad-names = foo,bar,baz,toto,tutu,tata
no-docstring-rgx = __.*__$|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$ no-docstring-rgx = ^_|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$
docstring-min-length = 5 docstring-min-length = 5
[FORMAT] [FORMAT]
...@@ -440,4 +444,4 @@ int-import-graph = ...@@ -440,4 +444,4 @@ int-import-graph =
[EXCEPTIONS] [EXCEPTIONS]
overgeneral-exceptions = Exception overgeneral-exceptions = Exception
# aebe69bb7440000dc1b4b9c5b162438a75e22d9d # c6a9056b56ee021936dc0bd6f092b36c5bb9ec12
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment