A simple flake8 plugin that checks if everything has a docstring

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for JakobDev from gravatar.com JakobDev

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD-2-Clause)
  • Author: JakobDev
  • Tags JakobDev, Docstrings, flake8
  • Requires: Python >=3.8
Classifiers
Report project as malware

Project description

flake8-docstring-checker

A simple flake8 plugin that checks if everything has a docstring. This plugin does not more than that. If you want a plugin which more functions you should take a look at flake8-docstrings.

List of warnings:

ID Description
DC100 Module has no docstring
DC101 Missing docstring in class
DC102 Missing docstring in public function
DC103 Missing docstring in private function
DC104 Missing docstring in special function

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page