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.0.2.tar.gz
(32.5 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-5.0.2.tar.gz.
File metadata
- Download URL: pydocstyle-5.0.2.tar.gz
- Upload date:
- Size: 32.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f4f5d210610c2d153fae39093d44224c17429e2ad7da12a8b419aba5c2f614b5 |
|
| MD5 | ee023f549e05b358d25793504f9e1dc1 |
|
| BLAKE2b-256 | 39f43f670e71f11c4c65f0d5f4153f5191fb38786483513c90de66f08ef6e810 |
File details
Details for the file pydocstyle-5.0.2-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-5.0.2-py3-none-any.whl
- Upload date:
- Size: 35.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da7831660b7355307b32778c4a0dbfb137d89254ef31a2b2978f50fc0b4d7586 |
|
| MD5 | 574258f3516683e2fc3f1ede154270b4 |
|
| BLAKE2b-256 | ccfb0662498401c663606ef35b4ec6a0aca6b4121d6da8c3ac40a4e68f6ac521 |
