Python docstring style checker
Project description
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 3.6+.
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)
...
Develop
You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -
Before submitting a PR make sure that you run make all.
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-6.2.1.tar.gz
(36.4 kB
view hashes)
Built Distribution
pydocstyle-6.2.1-py3-none-any.whl
(37.6 kB
view hashes)
Close
Hashes for pydocstyle-6.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e034023706489a5786778d21bd25e951052616b260d83e163f09d559dcd647b9 |
|
MD5 | a79aae231d5956eda6ecd4b3757416e0 |
|
BLAKE2b-256 | 1e4a70a55fe6dada5acf640b202a4c2cda39a74cc51222edd44154c914600e9d |