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 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
pydocstyle-2.0.0.zip
(33.3 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-2.0.0.zip.
File metadata
- Download URL: pydocstyle-2.0.0.zip
- Upload date:
- Size: 33.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 49680b7ea8c18e911135167e9f6986a3829031b55f2c737e6d2c398df38aafb5 |
|
| MD5 | 2be57712e2743d23949bafed957d8c86 |
|
| BLAKE2b-256 | b03352e2fa5662fbb2a8bc9bdfe31327cd58c2f856b31851b73fc5baf86a2a14 |
File details
Details for the file pydocstyle-2.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: pydocstyle-2.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 31.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 199fc5d0c03b737f0999613e2784bb5b47ad9ea0211b011ee5ea0afd51aa62e9 |
|
| MD5 | fabd0b1aa293481a466eb0366f32bfe7 |
|
| BLAKE2b-256 | 5cca0849f5a833575eb43c57dc5a40ca825615b234d161cc69bc9ce5867d7169 |
