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.5, 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-5.1.1.tar.gz
(33.0 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-5.1.1.tar.gz.
File metadata
- Download URL: pydocstyle-5.1.1.tar.gz
- Upload date:
- Size: 33.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19b86fa8617ed916776a11cd8bc0197e5b9856d5433b777f51a3defe13075325 |
|
| MD5 | cba020373d94fba224d100fbd00398cb |
|
| BLAKE2b-256 | a9771d835e40656d361bf8bd0add08d2c39dc257fb66ef8e29fe357c33826d5f |
File details
Details for the file pydocstyle-5.1.1-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-5.1.1-py3-none-any.whl
- Upload date:
- Size: 35.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aca749e190a01726a4fb472dd4ef23b5c9da7b9205c0a7857c06533de13fd678 |
|
| MD5 | 9cf5c34441c02c96e12a32087484fefa |
|
| BLAKE2b-256 | 3b3259d44a2ff98e87a35c33b99dc1b4f0bacdd968a8f37080eccd840f2f8e89 |
