pep257 (original) (raw)
Python docstring style checker
Project description
pep257 is a static analysis tool for checking compliance with Python PEP 257.
The framework for checking docstring style is flexible, and custom checks can be easily added, for example to cover NumPy docstring conventions.
pep257 supports Python 2.6, 2.7, 3.2, 3.3, 3.4, pypy and pypy3.
Quick Start
Install
pip install pep257Run
$ pep257 test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:22 in public method `method`:
D102: Docstring missing
...Links
Project details
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
File details
Details for the file pep257-0.7.0.tar.gz.
File metadata
- Download URL: pep257-0.7.0.tar.gz
- Upload date: Oct 9, 2015
- Size: 18.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Hashes for pep257-0.7.0.tar.gz | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | f3d67547f5617a9cfeb4b8097ed94a954888315defaf6e9b518ff1719363bf03 | | | MD5 | ff3dc9622c2406b7b583a283fbea651e | | | BLAKE2b-256 | 0337872af099c9864f7584bad9a561f6493d5d5eca9fc2b14c7d32407c90c639 | |
See more details on using hashes here.
File details
Details for the file pep257-0.7.0-py2.py3-none-any.whl.
File metadata
- Download URL: pep257-0.7.0-py2.py3-none-any.whl
- Upload date: Oct 9, 2015
- Size: 18.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Hashes for pep257-0.7.0-py2.py3-none-any.whl | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | d26cd2a4f572e0592f6967277136f581f924a4fe2aa38dcb7d4e532232689e80 | | | MD5 | daacc6ad5d9651c36a0180c4fa20af50 | | | BLAKE2b-256 | ec31e432e1aa35f692e3f6865fe07194f32536ec073ec7ad809cd3e7cb1a2b1a | |