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.1.zip
(26.6 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-1.1.1.zip.
File metadata
- Download URL: pydocstyle-1.1.1.zip
- Upload date:
- Size: 26.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f808d8fc23952fe93c2d85598732bfa854cb5ee8a25f8191f60600710f898e8d |
|
| MD5 | 4e2c692743e34adcce507479c8e76ebb |
|
| BLAKE2b-256 | c10814df5ee08a1bce1598de4e1cdedb7e55e09060971a7241d40d15a1d7a14a |
File details
Details for the file pydocstyle-1.1.1-py2.py3-none-any.whl.
File metadata
- Download URL: pydocstyle-1.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 40.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20939fb9c2d61a9870449573d9ed762ec040c764b2241bec22c5ea956b9caf90 |
|
| MD5 | 72c612755d05e9cb6eb05d4c3ed5182b |
|
| BLAKE2b-256 | c8ae3177fa31d3e97a47ddb7c5871c398c056d9f06a31b8d6792e71e4bbf81d5 |
