Skip to content

v1.3.0 of pydscheck
Compare
Choose a tag to compare
@davep davep released this 05 Jun 16:32
v1.3.0
80217fe
This commit was signed with the committer’s verified signature.
davep Dave Pearson
GPG key ID: 62CBF437CB933DAC
Learn about vigilant mode.

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>:.
Assets 2
Loading