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.1.0.tar.gz
(35.6 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-6.1.0.tar.gz.
File metadata
- Download URL: pydocstyle-6.1.0.tar.gz
- Upload date:
- Size: 35.6 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 | 4efd008c5a77fd202ce7540d3e2de3f6787693657862e848552bb404e1e05a8a |
|
| MD5 | 6c993a377b550f321a2b26e92937a809 |
|
| BLAKE2b-256 | e66a7312667a7af0fd63a3f8db5a3e97a969c66d3ddd005396b4501be84a384d |
File details
Details for the file pydocstyle-6.1.0-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-6.1.0-py3-none-any.whl
- Upload date:
- Size: 37.2 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 | f598604f0ac0e2673686770487179d83c515b8d1c765a177968a863994c3c156 |
|
| MD5 | 2eccba4414a5def5e8b31b3dc3c417db |
|
| BLAKE2b-256 | c4e58dd392ce56490aadcab870fd3fa310a3e53122fa267dd2da7256536c7a7e |
