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.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.
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-1.1.0.zip
(26.5 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-1.1.0.zip.
File metadata
- Download URL: pydocstyle-1.1.0.zip
- Upload date:
- Size: 26.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 956b4950623a3e085d3d73462035231ac160c5f53a6e44967f9d879c2b0aad01 |
|
| MD5 | f52fa81219abb856deab9af0df270227 |
|
| BLAKE2b-256 | 64d794b423691e720d96ff34014b67f8dfb8ab7b434dfc338f8d178543c61932 |
File details
Details for the file pydocstyle-1.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: pydocstyle-1.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 24.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 49e8c60ff4b7b4f192a5421819b1165deb6015bd7ddfb7709812937a391ca97b |
|
| MD5 | 1fa964c5625aaba2ae27319fb16417db |
|
| BLAKE2b-256 | 42ae67a288482857b728f2e84db2e5f48c6e5d6a9d44ba4eefbaf63e42a88e54 |
