Python docstring style checker
Project description
(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.3, 3.4, 3.5, 3.6 and pypy.
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)
...
Links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pydocstyle-2.1.1.tar.gz
(28.5 kB
view hashes)
Built Distributions
pydocstyle-2.1.1-py3-none-any.whl
(31.8 kB
view hashes)
pydocstyle-2.1.1-py2-none-any.whl
(31.9 kB
view hashes)
Close
Hashes for pydocstyle-2.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af9fcccb303899b83bec82dc9a1d56c60fc369973223a5e80c3dfa9bdf984405 |
|
MD5 | d2a332a4553c05852cc70f3ca793082f |
|
BLAKE2b-256 | 438af1141af0c8406788a5c38ad5001d4163d903b5384a6517239d2ac42734c8 |
Close
Hashes for pydocstyle-2.1.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08a870edc94508264ed90510db466c6357c7192e0e866561d740624a8fc7d90c |
|
MD5 | 94cae56b7210c68aeb817f1d6ffb0f35 |
|
BLAKE2b-256 | 4e20c710bd30d53c2786d1d9980a5f66598fb3e7348699858f40def7d625dedb |