Skip to content

Release v1.0.0
Compare
Choose a tag to compare
@github-actions github-actions released this 02 Jan 12:25
v1.0.0
c8c3eef
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Added

Function/ Method Arguments

  • Lint check that ensures all function/ method arguments are documented
  • Lint check that ensures docstring doesn't describe arguments the function/
    method doesn't have
  • Lint check that ensures there is at most one arguments section in the
    docstring
  • Lint check that ensures there is no empty arguments section in the docstring
  • Support for unused arguments for which descriptions are optional
  • Support *args and **kwargs
  • Support positional only arguments
  • Support keyword only arguments
  • Support ignoring self and cls arguments
  • Support for skipping test functions in test files
  • Support for skipping test fixtures in test and fixture files
  • Support async functions/ methods

Function/ Method Return Value

  • Lint check that ensures all functions/ methods that return a value have the
    returns section in the docstring
  • Lint check that ensures a function that does not return a value does not have
    the returns section
  • Lint check that ensures there is at most one returns section in the docstring

Function/ Method Yield Value

  • Lint check that ensures all functions/ methods that yield a value have the
    yields section in the docstring
  • Lint check that ensures a function that does not yield a value does not have
    the yields section
  • Lint check that ensures there is at most one yields section in the docstring

Function/ Method Exception Handling

  • Lint check that ensures all function/ method exceptions are documented
  • Lint check that ensures docstring doesn't describe exceptions the function/
    method doesn't raise
  • Lint check that ensures there is at most one raises section in the docstring
  • Lint check that ensures the raises section describes at least one exception

Class Attributes

  • Lint check that ensures all class attributes are documented
  • Lint check that ensures docstring doesn't describe attributes the class
    doesn't have
  • Lint check that ensures there is at most one attributes section in the
    docstring
  • Support for private attributes for which descriptions are optional
  • Support for class attributes defined on the class and other classmethod
    methods
  • Support for instance attributes defined in __init__ and other non-static and
    non-classmethod methods
  • Support async functions/ methods
Assets 2
Loading