Releases: davep/pydscheck
v1.9.0
v1.8.0 of pydscheck
Made Python 3.7 the base required Python version for the tool.
v1.7.0 of pydscheck
Added an extended test that checks if all of the named parameters for a function are documented in the doc string.
v1.6.0 of pydscheck
Added an "extra check" check to the extra checks that a property has a :type:
.
v1.5.0 of pydscheck
Added support for treating a yield
like a return
when it comes to checking for a :returns:
in the doc string of a function.
v1.4.0 of pydscheck
Added checks to see if a param
or an ivar
has a declared type, as part of the --extra-checks
option.
v1.3.1 of pydscheck
Fixes a bug where a function that returns nothing, but which contains a function that returns something, would appear to be a function that returns something.
v1.3.0 of pydscheck
Added the start of an "extra checks" facility. This goes beyond the initial simple check the tool was designed to perform and starts to look inside the doc-string and check for other things. Those other things right now includes:
- If the code of a function returns something, a
:returns:
must appear in the doc string. - If a
:returns:
appears in the doc string, there should also be a:rtype:
. - If a
:raises:
appears in the doc string, it should be of the form:raises <error-class>:
.
v1.2.2 of pydscheck
- Better handle the user Ctrl+Cing their way out.
- Better report ignored directories.
v1.2.1 of pydscheck
Various internal changes and improvements.