diff options
| author | Konstantina Saketou <56515303+ksaketou@users.noreply.github.com> | 2021-10-10 11:45:05 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-10 10:45:05 +0200 |
| commit | f2b0c48536c008410e6c3eab51ea1042b96829e2 (patch) | |
| tree | 3645b82be657071d49aff8567e833553890300a2 /doc | |
| parent | 1eaf5aa211a16607a0f15cae56a90e94555f3809 (diff) | |
| download | pylint-git-f2b0c48536c008410e6c3eab51ea1042b96829e2.tar.gz | |
Properly identify undocumented parameters and add new message called missing-any-param-doc (#5097)
* Correctly identify parameters with no doc and add new message
This commit fixes the problem where non documented parameters where not being
identified properly. Also, it adds a new message called ``missing-any-param-doc`` for
when a function has no parameter and type doc at all.
Adds new test cases for the ``missing-param-doc`` and ``missing-type-doc`` messages
and tests for the new message ``missing-any-param-doc``.
* Replace old messages with the new one where needed
Fix pylint's code where the new message where needed in other files instead of
triggering both missing-param-doc and missing-type-doc.
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/whatsnew/2.12.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/whatsnew/2.12.rst b/doc/whatsnew/2.12.rst index 7cdd12003..f6d99185a 100644 --- a/doc/whatsnew/2.12.rst +++ b/doc/whatsnew/2.12.rst @@ -12,6 +12,13 @@ Summary -- Release highlights New checkers ============ +* Added ``missing-any-param-doc`` triggered when a function has neither parameter nor parameter type + documentation. Undocumented parameters are now being properly identified. A warning might start to + appear unexpectedly if ``missing-param-doc`` and ``missing-type-doc`` were disabled, as a new message + ``missing-any-param-doc`` will be emitted instead. + + Closes #3799 + * Checkers for ``typing.final`` * Added ``overridden-final-method``: Emitted when a method which is annotated with ``typing.final`` is overridden |