summaryrefslogtreecommitdiff
path: root/pylint/extensions/check_docs.py
Commit message (Collapse)AuthorAgeFilesLines
* Remove the ``check_docs`` extension and remove any references to it (#5730)Daniël van Noord2022-01-271-25/+0
|
* Add typing and uniformize the checker registering in Pylinter (#5558)Pierre Sassoulas2021-12-271-5/+4
| | | | | Remove verbose docstring in code, keep them in example and doc Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
* Bump pylint to 2.9.4, update changelogv2.9.4Pierre Sassoulas2021-07-201-1/+1
|
* Bump pylint to 2.9.3, update changelogv2.9.3Pierre Sassoulas2021-07-011-0/+1
|
* Fix copyright links (#4647)Marc Mueller2021-07-011-1/+1
| | | | * Fix link in license header * Update link to astroid bump_changelog
* Rename copying to license and upgrade the setup.cfg (#4338)Pierre Sassoulas2021-04-111-1/+1
|
* Update copyright notice with copyritePierre Sassoulas2021-02-281-0/+1
|
* Apply copyrite --contribution-thresholdPierre Sassoulas2021-02-211-0/+1
|
* Sets up copyrighthippo912020-08-201-1/+1
|
* Add missing copyright annotations for the past releasesClaudiu Popa2020-04-271-1/+1
|
* Reformat the code with blackClaudiu Popa2018-09-171-2/+4
|
* Even more granular copyrights (thanks to copyrite)Claudiu Popa2016-07-231-2/+4
|
* Keep a consistent copyright notice across the board.Claudiu Popa2016-07-191-0/+2
| | | | | This was changed automatically in #894, but apparently we need to have the copyright notice somewhere.
* Remove trailing line.Claudiu Popa2016-07-071-1/+0
|
* Add a check_docs file, that registers into docparams, for maintaining ↵Claudiu Popa2016-07-071-0/+18
| | | | backward compatibility.
* Move the docstring param checker to docparams.py.Claudiu Popa2016-06-301-295/+0
|
* Rename the docstring parameter checker to something that suggest more ↵Claudiu Popa2016-06-301-3/+3
| | | | clearly what it does.
* Fixed our docstring lint errorsAshley Whetter2016-06-251-0/+1
|
* check_docs warns for redundant return docstring (#929)Ashley Whetter2016-06-051-3/+17
| | | Fixes #734
* Add the new shorter license header, including to missing files. Close #894.Claudiu Popa2016-06-011-0/+3
|
* Check docs improvements (#918)Ashley Whetter2016-05-301-2/+2
| | | | | | Fixed linting docstring when function has args or kwargs and fixed missing-param-doc with leading asterisks in Google docstring Leading asterisks are allowed on the name of args and kwargs in a Google docstring but we weren't checking for these.
* Added return docstring checking to check_docs (#914)Ashley Whetter2016-05-251-1/+28
| | | | Added return docstring checking to check_docs
* Added a new extension for checking documented exceptions raised (#904)Ashley Whetter2016-05-201-175/+77
| | | | | Add check_raises_docs Closes #904
* [ADD] check_docs can find constructor parameters in __init__ (#887)Ashley Whetter2016-04-301-7/+44
| | | | Also added warning W9005 to indicate when constructor parameters are documented in both the class docstring and __init__ docstring.
* Take in account kwonlyargs when verifying that arguments are definedClaudiu Popa2016-01-091-1/+1
| | | | Closes #745
* Use the new node names for the visit and leave methodsClaudiu Popa2015-08-261-1/+1
| | | | | Also, emit a PendingDeprecationWarning if the old names are still used, this support being removed in pylint 2.0.
* Cleanup.Claudiu Popa2015-05-111-35/+27
|
* Change the name of the parameter checker, so that it can be chosen easily at ↵Claudiu Popa2015-05-101-1/+1
| | | | command line.
* method visit_class is no longer necessary in the checker; auxiliary method ↵Bruno Daniel2015-05-101-11/+0
| | | | _visit_methods_of_class in the unit test
* check_docs: Handle class constructors from within visit_function.Bruno Daniel2015-05-101-10/+17
|
* accept-no-param-doc turned into a yes/no option; documentation for this ↵Bruno Daniel2015-05-101-2/+1
| | | | parameter
* check_docs: implementation of option "accept-no-param-doc"Bruno Daniel2015-05-101-2/+10
|
* better naming, because the checker now supports not just the Sphinx styleBruno Daniel2015-05-101-22/+21
|
* unittest for Google style parameter documentation; first implementation of ↵Bruno Daniel2015-05-101-28/+130
| | | | Google and numpy style parameter documentation
* check_docs: Emit error messages only when it detects that at least one ↵Bruno Daniel2015-05-081-1/+10
| | | | :param: definition is found? In that case, we will actually know that the user intended to use Sphinx style documentation or not.
* Tolerate no Sphinx parameter documentation at all: unit testBruno Daniel2015-05-081-0/+206