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 pep257
Run
$ pep257 test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:22 in public method `method`:
D102: Docstring missing
...
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.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size pep257-0.7.0-py2.py3-none-any.whl (18.5 kB) | File type Wheel | Python version 2.7 | Upload date | Hashes View |
| Filename, size pep257-0.7.0.tar.gz (18.2 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for pep257-0.7.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d26cd2a4f572e0592f6967277136f581f924a4fe2aa38dcb7d4e532232689e80 |
|
| MD5 | daacc6ad5d9651c36a0180c4fa20af50 |
|
| BLAKE2-256 | ec31e432e1aa35f692e3f6865fe07194f32536ec073ec7ad809cd3e7cb1a2b1a |
