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.0.tar.gz
(33.0 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-5.1.0.tar.gz.
File metadata
- Download URL: pydocstyle-5.1.0.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 | 4ca3c7736d36f92bb215dd74ef84ac3d6c146edd795c7afc5154c10f1eb1f65a |
|
| MD5 | 2a9a46c946979de0bbdf55384d62b753 |
|
| BLAKE2b-256 | 79e9da748aa8fc2e7c1d5312e02318196637fd49e4a285a61d243d73b608dfc7 |
File details
Details for the file pydocstyle-5.1.0-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-5.1.0-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 | 08374b9d4d2b7164bae50b71bb24eb0d74a56b309029d5d502264092fa7db0c3 |
|
| MD5 | 113b403bd1d6086518a06656a2b33b05 |
|
| BLAKE2b-256 | 564856b211a41211fc473fcc180c27e8caa132a9528790caab11828c5cc92df5 |
