Extension for flake8 which uses pydocstyle to check docstrings
Project Links
Meta
Author: Simon ANDRÉ
Maintainer: Ian Cordasco
Requires Python: >=3.7
Classifiers
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 3
- Python :: 3 :: Only
- Python :: Implementation :: CPython
A simple module that adds an extension for the fantastic pydocstyle tool to flake8.
Simply install this extension:
pip install flake8-docstrings
and run flake8.
You can set the pydocstyle convention at the command line using:
$ flake8 --docstring-convention numpy ...
Or, adding docstring-convention=numpy to your flake8 configuration file. The available set of conventions depends on the version of pydocstyle installed. The default is pep257, pydocstyle v2.0.0 added numpy (for the numpydoc standard), while pydocstyle v4.0.0 added google.
In order to choose a custom list of error codes, use the special value docstring-convention=all, then choose the codes you want checked using flake8’s built-in --ignore/--select functionality.
Report any issues on our bug tracker.
1.7.0
Jan 25, 2023
1.6.0
Mar 19, 2021
1.5.0
Sep 30, 2019
1.4.0
Aug 26, 2019
1.3.1
Aug 02, 2019
1.3.0
Jan 04, 2018
1.2.0
Jan 04, 2018
1.1.0
Apr 28, 2017
1.0.3
Jan 24, 2017
1.0.2
Jul 26, 2016
1.0.1
Jul 26, 2016
0.2.8
Jun 17, 2016
0.2.7
Jun 16, 2016
0.2.6
May 01, 2016
0.2.5
Feb 17, 2016
0.2.4
Nov 25, 2015
0.2.3
Nov 24, 2015
0.2.2
Nov 24, 2015
0.2.1.post1
Jan 07, 2015
0.2.1
Oct 01, 2014
0.2.0
Mar 07, 2014
0.1.4
Jan 03, 2014
0.1.3
Oct 08, 2013
0.1.2
Jun 16, 2013
0.1.1
Jun 03, 2013
0.1.0
May 22, 2013
