pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-10 14:54:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more definitions to glossary

Browse source
This commit is contained in:
Ian Cordasco 2016-06-22 19:27:10 -05:00
parent 478d5620d8
commit 1de5da8a7f
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/source/glossary.rst
View file

@ -22,8 +22,25 @@
the user configured maximum) or a lint check (e.g., checking for the user configured maximum) or a lint check (e.g., checking for
unused imports) or some other check as defined by a plugin. unused imports) or some other check as defined by a plugin.
error
error code error code
The symbol associated with a specific :term:`check`. For example, The symbol associated with a specific :term:`check`. For example,
pycodestyle implements :term:`check`\ s that look for whitespace pycodestyle implements :term:`check`\ s that look for whitespace
around binary operators and will either return an error code of around binary operators and will either return an error code of
W503 or W504. ``W503`` or ``W504``.
warning
Typically the ``W`` class of :term:`error code`\ s from pycodestyle.
class
error class
A larger grouping of related :term:`error code`\ s. For example,
``W503`` and ``W504`` are two codes related to whitespace. ``W50``
would be the most specific class of codes relating to whitespace.
``W`` would be the warning class that subsumes all whitespace
errors.
pyflakes
The project |Flake8| depends upon to lint files (check for unused
imports, variables, etc.). This uses the ``F`` :term:`class` of
:term:`error code`\ s reported by |Flake8|.