Python docstring style checker
Project description
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 3.5, 3.6, 3.7 and 3.8.
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-5.0.1.tar.gz
(32.5 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-5.0.1.tar.gz.
File metadata
- Download URL: pydocstyle-5.0.1.tar.gz
- Upload date:
- Size: 32.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/27.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a0de36e549125d0a16a72a8c8c6c9ba267750656e72e466e994c222f1b6e92cb |
|
| MD5 | 033615a5774605724526905f4307e32e |
|
| BLAKE2b-256 | ac97878e4216091aa92550e721344792be599e664ed3088ccdfa807e27316908 |
File details
Details for the file pydocstyle-5.0.1-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-5.0.1-py3-none-any.whl
- Upload date:
- Size: 35.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/27.2.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4167fe954b8f27ebbbef2fbcf73c6e8ad1e7bb31488fce44a69fdfc4b0cd0fae |
|
| MD5 | 7bde5ebb2bfc9698af03d14191998749 |
|
| BLAKE2b-256 | 1ac38e8a0fba20b2b543747e9571ad22ede9889035d9aeb82f68c242bc555941 |
