diff options
| -rw-r--r-- | doc/extensions.rst | 4 | ||||
| -rw-r--r-- | pylint/extensions/check_docs.py | 3 |
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/extensions.rst b/doc/extensions.rst index 204fde3..36a4849 100644 --- a/doc/extensions.rst +++ b/doc/extensions.rst @@ -140,3 +140,7 @@ docstring defining the interface, e.g. a superclass method, after "see":: Naming inconsistencies in existing parameter and their type documentations are still detected. + +By default, omitting the parameter documentation of a function altogether is +tolerated without any warnings. If you want to switch off this behavior, +set the option ``accept-no-param-doc`` to ``yes`` in your ``.pylintrc``. diff --git a/pylint/extensions/check_docs.py b/pylint/extensions/check_docs.py index 6c29262..de8b8f4 100644 --- a/pylint/extensions/check_docs.py +++ b/pylint/extensions/check_docs.py @@ -55,8 +55,7 @@ class ParamDocChecker(BaseChecker): } options = (('accept-no-param-doc', - {'default': True, - 'type': 'bool', + {'default': True, 'type' : 'yn', 'metavar' : '<y or n>', 'help': 'Whether to accept totally missing parameter ' 'documentation in a docstring of a function that has ' 'parameters' |