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.1.tar.gz
(35.7 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-6.1.1.tar.gz.
File metadata
- Download URL: pydocstyle-6.1.1.tar.gz
- Upload date:
- Size: 35.7 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 | 1d41b7c459ba0ee6c345f2eb9ae827cab14a7533a88c5c6f7e94923f72df92dc |
|
| MD5 | ef5e1670cd3fd1f3a24cceb76493759e |
|
| BLAKE2b-256 | 4c304cdea3c8342ad343d41603afc1372167c224a04dc5dc0bf4193ccb39b370 |
File details
Details for the file pydocstyle-6.1.1-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-6.1.1-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 | 6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4 |
|
| MD5 | 0f218a198f2f8012ed68036252c4bed3 |
|
| BLAKE2b-256 | 87674df10786068766000518c6ad9c4a614e77585a12ab8f0654c776757ac9dc |
