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.0.tar.gz
(32.5 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-5.0.0.tar.gz.
File metadata
- Download URL: pydocstyle-5.0.0.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/27.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d85eb88a0650756ea44d91917c1eb3a20903eeb163285774721a4807190fce24 |
|
| MD5 | d8d602620d2779c105ceaddf67cf502f |
|
| BLAKE2b-256 | 905b17df0e72bfd3a16a98a32c52dda0a8fee87a51a3a778a997c33a27b7c95e |
File details
Details for the file pydocstyle-5.0.0-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-5.0.0-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/27.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7f2b7e70c4e6951d0f2aff445b670a336a28c56c0a40275dc8620a93ac2140c3 |
|
| MD5 | 008439297e5593d6536b7b5cacabb003 |
|
| BLAKE2b-256 | 41a0883eeb609c7a19095e1f69b6e8ed44acf03bf7c58f919f837b93d2510556 |
