Python docstring style checker
Project Links
Meta
Author: Amir Rachum
Requires Python: >=3.6
Classifiers
Development Status
- 5 - Production/Stable
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 3
- Python :: 3.6
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
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
6.3.0
Jan 17, 2023
6.2.3
Jan 08, 2023
6.2.2
Jan 03, 2023
6.2.1
Jan 03, 2023
6.2.0
Jan 02, 2023
6.1.1
May 17, 2021
6.1.0
May 17, 2021
6.0.0
Mar 18, 2021
5.1.1
Aug 29, 2020
5.1.0
Aug 22, 2020
5.0.2
Jan 10, 2020
5.0.1
Dec 09, 2019
5.0.0
Dec 09, 2019
4.0.1
Aug 15, 2019
4.0.0
Jul 06, 2019
3.0.0
Oct 14, 2018
2.1.1
Oct 09, 2017
2.1.0
Oct 08, 2017
2.0.0
Apr 18, 2017
1.1.1
Oct 04, 2016
1.1.0
Sep 29, 2016
1.0.0
Jan 30, 2016
