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.6+.
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)
...Develop
You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -
Before submitting a PR make sure that you run make all.
Links
Project details
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-6.3.0.tar.gz
(36.8 kB
view details)
Built Distribution
File details
Details for the file pydocstyle-6.3.0.tar.gz.
File metadata
- Download URL: pydocstyle-6.3.0.tar.gz
- Upload date:
- Size: 36.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.10.6 Linux/5.15.0-1030-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1 |
|
| MD5 | 8fa0c9de748b1107960c61a24d21dadd |
|
| BLAKE2b-256 | e95cd5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953 |
File details
Details for the file pydocstyle-6.3.0-py3-none-any.whl.
File metadata
- Download URL: pydocstyle-6.3.0-py3-none-any.whl
- Upload date:
- Size: 38.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.10.6 Linux/5.15.0-1030-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019 |
|
| MD5 | 3475c014e11a43cb2a991c24a659b947 |
|
| BLAKE2b-256 | 36ea99ddefac41971acad68f14114f38261c1f27dac0b3ec529824ebc739bdaa |