Skip to content

Releases: jdkandersson/flake8-docstrings-complete

Release v1.3.0

29 Nov 07:53
83fdea8
Compare
Choose a tag to compare

Added

  • Support for typing.overload.

Release v1.2.0

11 Jul 15:43
d63a6d8
Compare
Choose a tag to compare

Added

  • Support for functools.cached_property.

Release v1.1.0

26 Jan 02:38
4664a5b
Compare
Choose a tag to compare

Added

  • Lint check that ensures all function/ method arguments are described only
    once.
  • Lint check that ensures all class attributes are described only once.
  • Lint check that ensures all raised exceptions are described only once.

Release v1.0.4

13 Jan 13:05
179f219
Compare
Choose a tag to compare

Changed

  • Changed only class attributes to be required in class attributes section,
    instance attributes are now optional

Release v1.0.3

05 Jan 01:54
2310f32
Compare
Choose a tag to compare

Added

  • Support for class properties

Release v1.0.2

04 Jan 07:38
57767b0
Compare
Choose a tag to compare

Added

  • Support for flake8 version 5

Release v1.0.1

03 Jan 09:03
96b1835
Compare
Choose a tag to compare

Fixed

  • Fixed definition of a section start to be a non-empty line rather than based
    on whether it has a named header like

Release v1.0.0

02 Jan 12:25
c8c3eef
Compare
Choose a tag to compare

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