diff options
| author | Bruno Daniel <bruno.daniel@blue-yonder.com> | 2015-05-10 14:13:31 +0200 |
|---|---|---|
| committer | Bruno Daniel <bruno.daniel@blue-yonder.com> | 2015-05-10 14:13:31 +0200 |
| commit | 0dd11d29995d044cde8402c5c8ec3659da262bea (patch) | |
| tree | 12bed4156edf30717dcdbe52017c9f0b54a6a3a2 /doc | |
| parent | 04a91e2bf8ac01ffff76e68bbddeed027dbc3f43 (diff) | |
| download | pylint-0dd11d29995d044cde8402c5c8ec3659da262bea.tar.gz | |
accept-no-param-doc turned into a yes/no option; documentation for this parameter
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/extensions.rst | 4 |
1 files changed, 4 insertions, 0 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``. |