Skip to content

A flake8 plugin to check whether functions and methods have docstrings, while omitting some common false positives.

License

Notifications You must be signed in to change notification settings

nicejobinc/flake8-has-docstring

Repository files navigation

flake8-has-docstring

A flake8 plugin that checks that functions have docstrings.

This package adds the following warnings:

  • UUG001: An unused global variable.

There are no configuration options at this time.

The following functions are currently unchecked:

  • Functions which are decorated with @pytest.fixture.
  • Functions which are decorated with @typing.overload.

About

A flake8 plugin to check whether functions and methods have docstrings, while omitting some common false positives.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages