diff options
| author | Daniƫl van Noord <13665637+DanielNoord@users.noreply.github.com> | 2021-10-14 12:19:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-14 12:19:51 +0200 |
| commit | 9ae82580ec70058a6a3f70ccdeb97a2b1ed4df3d (patch) | |
| tree | 20f134509a7cc458e971efe495e1e8ef1c8fb0a4 /pylint | |
| parent | 3a5a91c0fa0761555aed2cb03270e2bb63b400fb (diff) | |
| download | pylint-git-9ae82580ec70058a6a3f70ccdeb97a2b1ed4df3d.tar.gz | |
Improve documentation of ``docparams`` extension and fix tests (#5095)
This closes #4136
Diffstat (limited to 'pylint')
| -rw-r--r-- | pylint/extensions/docparams.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/pylint/extensions/docparams.rst b/pylint/extensions/docparams.rst index e46c4dcd7..e9e0eea00 100644 --- a/pylint/extensions/docparams.rst +++ b/pylint/extensions/docparams.rst @@ -90,6 +90,9 @@ You'll be notified of **missing parameter documentation** but also of **naming inconsistencies** between the signature and the documentation which often arise when parameters are renamed automatically in the code, but not in the documentation. +**Note:** by default docstrings of private and magic methods are not checked. +To change this behaviour (for example, to also check ``__init__``) add +``no-docstring-rgx=^(?!__init__$)_`` to the ``BASIC`` section of your ``.pylintrc``. Constructor parameters can be documented in either the class docstring or the ``__init__`` docstring, but not both:: |
