Claudiu Popa
3f28424007
Reformat the code with black
2018-09-17 09:07:42 +02:00
Claudiu Popa
ec09cc7578
Even more granular copyrights (thanks to copyrite)
2016-07-23 00:22:28 +03:00
Claudiu Popa
211d81f84f
Keep a consistent copyright notice across the board.
...
This was changed automatically in #894 , but apparently
we need to have the copyright notice somewhere.
2016-07-19 17:42:07 +03:00
Claudiu Popa
340f62bd99
Remove trailing line.
2016-07-07 16:28:13 +01:00
Claudiu Popa
9423e31126
Add a check_docs file, that registers into docparams, for maintaining backward compatibility.
2016-07-07 15:54:29 +01:00
Claudiu Popa
4ca94bbada
Move the docstring param checker to docparams.py.
2016-06-30 14:40:01 +01:00
Claudiu Popa
f5bb53437e
Rename the docstring parameter checker to something that suggest more clearly what it does.
2016-06-30 14:37:17 +01:00
Ashley Whetter
0d170658ef
Fixed our docstring lint errors
2016-06-25 21:31:35 +01:00
Ashley Whetter
5df3bf1a8f
check_docs warns for redundant return docstring ( #929 )
...
Fixes #734
2016-06-05 19:53:02 +01:00
Claudiu Popa
8322781baa
Add the new shorter license header, including to missing files. Close #894 .
2016-06-01 16:25:07 +01:00
Ashley Whetter
3d0478132e
Check docs improvements ( #918 )
...
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.
2016-05-30 13:49:11 +01:00
Ashley Whetter
21424f2faa
Added return docstring checking to check_docs ( #914 )
...
Added return docstring checking to check_docs
2016-05-25 12:07:38 +01:00
Ashley Whetter
05eb7fd20e
Added a new extension for checking documented exceptions raised ( #904 )
...
Add check_raises_docs
Closes #904
2016-05-20 13:58:24 +01:00
Ashley Whetter
a994eeb620
[ADD] check_docs can find constructor parameters in __init__ ( #887 )
...
Also added warning W9005 to indicate when constructor parameters are documented
in both the class docstring and __init__ docstring.
2016-04-30 14:09:24 +03:00
Claudiu Popa
d2a7144d29
Take in account kwonlyargs when verifying that arguments are defined
...
Closes #745
2016-01-09 13:36:45 +02:00
Claudiu Popa
a1b3c9623a
Use the new node names for the visit and leave methods
...
Also, emit a PendingDeprecationWarning if the old names are still
used, this support being removed in pylint 2.0.
2015-08-26 22:09:27 +03:00
Claudiu Popa
bbc61a1b92
Cleanup.
2015-05-11 00:08:31 +03:00
Claudiu Popa
ea27a8349b
Change the name of the parameter checker, so that it can be chosen easily at command line.
2015-05-10 23:57:47 +03:00
Bruno Daniel
e9a7fca36c
method visit_class is no longer necessary in the checker; auxiliary method _visit_methods_of_class in the unit test
2015-05-10 14:47:29 +02:00
Bruno Daniel
08c9b3e655
check_docs: Handle class constructors from within visit_function.
2015-05-10 14:38:13 +02:00
Bruno Daniel
743e42c9cc
accept-no-param-doc turned into a yes/no option; documentation for this parameter
2015-05-10 14:13:31 +02:00
Bruno Daniel
cfa9e110ac
check_docs: implementation of option "accept-no-param-doc"
2015-05-10 13:57:24 +02:00
Bruno Daniel
e28051fc88
better naming, because the checker now supports not just the Sphinx style
2015-05-10 13:10:27 +02:00
Bruno Daniel
ce8fcc55e4
unittest for Google style parameter documentation; first implementation of Google and numpy style parameter documentation
2015-05-10 12:38:09 +02:00
Bruno Daniel
9650beb4d6
check_docs: Emit error messages only when it detects that at least one :param: definition is found? In that case, we will actually know that the user intended to use Sphinx style documentation or not.
2015-05-08 17:49:24 +02:00
Bruno Daniel
e25399590e
Tolerate no Sphinx parameter documentation at all: unit test
2015-05-08 17:36:21 +02:00
