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.
The framework for checking docstring style is flexible, and custom checks can be easily added, for example to cover NumPy docstring conventions.
pydocstyle supports Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.
Quick Start
Install
pip install pydocstyleRun
$ pydocstyle test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:22 in public method `method`:
D102: Docstring missing
...Links
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-1.0.0.zip
(21.6 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-1.0.0.zip.
File metadata
- Download URL: pydocstyle-1.0.0.zip
- Upload date:
- Size: 21.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d553c094483581c11e61c91f2f5da5d578e428f8f800f00d209eb12e090874c4 |
|
| MD5 | 74a42c1c8148f80c8f2931b615b54a24 |
|
| BLAKE2b-256 | 3aaee00f314bdf4654329aab3f0443cb5b213c79cc25002e49a2f8cbf8a09936 |
File details
Details for the file pydocstyle-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: pydocstyle-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 19.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b22548c337608e2535c42149f58e65faba0d0c5dd42b29ffd1c3c009a3b6bd59 |
|
| MD5 | 5adf95b7d25a60f05e7f8d9e5fddfb8b |
|
| BLAKE2b-256 | fee6e6ed14c372bd1ed58a19ef20e8f83a4ebbd1ecdbc9818f063be38189a5f6 |
