GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → PyCQA → flake8-docstrings

PyCQA / flake8-docstrings

Licence: MIT License
Integration of pydocstyle and flake8 for combined linting and reporting

Programming Languages

python
139335 projects - #7 most used programming language

Labels

flake8pydocstyledocstringsflake8-pluginflake8-extension

Projects that are alternatives of or similar to flake8-docstrings

flake8-broken-line
🚨 Flake8 plugin to forbid backslashes (\) for line breaks
Stars: ✭ 85 (+16.44%)
Mutual labels:  flake8, flake8-plugin
flake8-simplify
❄ A flake8 plugin that helps you to simplify code
Stars: ✭ 97 (+32.88%)
Mutual labels:  flake8, flake8-plugin
flake8-alfred
Alfred is a flake8 plugin to warn on unsafe/obsolete symbols.
Stars: ✭ 26 (-64.38%)
Mutual labels:  flake8, flake8-plugin
flake8-functions
flake8 plugin for validation of function parameters (length, complexity, etc)
Stars: ✭ 32 (-56.16%)
Mutual labels:  flake8, flake8-plugin
flake8-annotations
Flake8 Type Annotation Checking
Stars: ✭ 117 (+60.27%)
Mutual labels:  flake8, flake8-plugin
Wemake Python Styleguide
The strictest and most opinionated python linter ever!
Stars: ✭ 1,714 (+2247.95%)
Mutual labels:  flake8, flake8-plugin
flake8-cognitive-complexity
An extension for flake8 that validates cognitive functions complexity
Stars: ✭ 44 (-39.73%)
Mutual labels:  flake8, flake8-plugin
flake8-type-checking
Flake8 plugin for managing type-checking imports & forward references.
Stars: ✭ 38 (-47.95%)
Mutual labels:  flake8, flake8-plugin
dlint
Dlint is a tool for encouraging best coding practices and helping ensure Python code is secure.
Stars: ✭ 130 (+78.08%)
Mutual labels:  flake8
google classroom
Google Classroom Data Pipeline
Stars: ✭ 17 (-76.71%)
Mutual labels:  flake8
vim-nayvy
🌑 Enriching python coding in Vim 🐍
Stars: ✭ 66 (-9.59%)
Mutual labels:  docstrings
numpydoc.el
Insert NumPy style docstrings in Python functions.
Stars: ✭ 33 (-54.79%)
Mutual labels:  docstrings
sphinx-rest-cheatsheet
A compact cheat sheet for writing documentation string for Sphinx, with focus on Python.
Stars: ✭ 17 (-76.71%)
Mutual labels:  docstrings
jira-sprint-analytics
No description or website provided.
Stars: ✭ 13 (-82.19%)
Mutual labels:  flake8
flake8-assertive
Flake8 unittest assert method checker
Stars: ✭ 30 (-58.9%)
Mutual labels:  flake8
flake8-putty
Flake8 plugin to control reporting per file and line
Stars: ✭ 38 (-47.95%)
Mutual labels:  flake8-plugin
jupyterlab-flake8
Jupyterlab python linter for notebooks and text files using flake8
Stars: ✭ 105 (+43.84%)
Mutual labels:  flake8
sphinxcontrib-django
This is a sphinx extension which improves the documentation of Django apps.
Stars: ✭ 37 (-49.32%)
Mutual labels:  docstrings
flake8-html
Generate HTML reports of flake8 violations
Stars: ✭ 40 (-45.21%)
Mutual labels:  flake8-plugin
flake8-aaa
A Flake8 plugin that checks Python tests follow the Arrange-Act-Assert pattern
Stars: ✭ 51 (-30.14%)
Mutual labels:  flake8-plugin
View All Similar Projects ➔

flake8-docstrings

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].