Skip to main content

Python docstring style checker

Project description

https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master https://ci.appveyor.com/api/projects/status/40kkc366bmrrttca/branch/master?svg=true Documentation Status https://img.shields.io/pypi/pyversions/pydocstyle.svg

(formerly pep257)

pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.

pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.

pydocstyle supports Python 2.7, 3.4, 3.5, 3.6, 3.7, and pypy.

Attention!

Support for Python 2.7 will be removed in the next release.

Quick Start

Install

pip install pydocstyle

Run

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pydocstyle-3.0.0-py2-none-any.whl (32.2 kB) Copy SHA256 hash SHA256 Wheel 2.7
pydocstyle-3.0.0-py3-none-any.whl (33.0 kB) Copy SHA256 hash SHA256 Wheel 3.6
pydocstyle-3.0.0.tar.gz (29.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page