Python docstring style checker
Project description
(formerly pep257)
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 2.7, 3.3, 3.4, 3.5, 3.6 and pypy.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pydocstyle-2.1.0.tar.gz.
File metadata
- Download URL: pydocstyle-2.1.0.tar.gz
- Upload date:
- Size: 28.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57446e356544898376237651d6e34c348f6518bff072aca7bc8b14f35709b67d
|
|
| MD5 |
291d7b3df72766aecba2683f87dde9b3
|
|
| BLAKE2b-256 |
326ab500937a4098be1e890f34590219ee6998f02a0256ab228969494b64fbca
|
File details
Details for the file pydocstyle-2.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: pydocstyle-2.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 31.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65e7856618f55a0ad57bc2fcede88a9f5e4f755b3f35e262d3339e82b5efeab5
|
|
| MD5 |
eeddf1eb4b069cb0a6ad8ff8c2cc07d9
|
|
| BLAKE2b-256 |
211d2afb75448d496a1a53815a5e2edd5fc8828eff6730ae29ce18801d2d4077
|
