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, 3.7 and 3.8.
Quick Start
Install
pip install pydocstyleRun
$ 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
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.0.0.tar.gz
(34.3 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-6.0.0.tar.gz.
File metadata
- Download URL: pydocstyle-6.0.0.tar.gz
- Upload date:
- Size: 34.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 164befb520d851dbcf0e029681b91f4f599c62c5cd8933fd54b1bfbd50e89e1f |
|
| MD5 | 284ea5ad2daf9a83d3eab43275ab9252 |
|
| BLAKE2b-256 | 3fcf449b94b75a0a2182796ae351b7130ee0ffd503536870a2074aab08774c74 |
File details
Details for the file pydocstyle-6.0.0-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-6.0.0-py3-none-any.whl
- Upload date:
- Size: 36.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d4449cf16d7e6709f63192146706933c7a334af7c0f083904799ccb851c50f6d |
|
| MD5 | 91f54eb306a2803a64af4793d65c2c28 |
|
| BLAKE2b-256 | c5f02211d04ef3054c09b2b193e5f377db945e5cfd1fc401eb44a78023df5c24 |
