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.4, 3.5, 3.6 and 3.7.
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-4.0.1.tar.gz
(31.4 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-4.0.1.tar.gz.
File metadata
- Download URL: pydocstyle-4.0.1.tar.gz
- Upload date:
- Size: 31.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04c84e034ebb56eb6396c820442b8c4499ac5eb94a3bda88951ac3dc519b6058 |
|
| MD5 | 6fb92647e560610b3acd849e6f1fdaab |
|
| BLAKE2b-256 | 10ebe6bc79c82c402d226a9119f3ff2e573bb567b8170564becc2dd783ef73fd |
File details
Details for the file pydocstyle-4.0.1-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-4.0.1-py3-none-any.whl
- Upload date:
- Size: 33.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 66aff87ffe34b1e49bff2dd03a88ce6843be2f3346b0c9814410d34987fbab59 |
|
| MD5 | 0f2d1497fa74231a275d1af286a4326b |
|
| BLAKE2b-256 | 4b175a4834af38d2afd796ec33b809a570966a8173dacabc44cbc30e75001b4f |
