Start a glossary of terms

This commit is contained in:
Ian Cordasco 2016-06-22 14:34:14 -05:00
parent 601696d564
commit 88d1dd280a
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
2 changed files with 33 additions and 2 deletions

29
docs/source/glossary.rst Normal file
View file

@ -0,0 +1,29 @@
.. _glossary:
================================================
Glossary of Terms Used in Flake8 Documentation
================================================
.. glossary::
:sorted:
formatter
A :term:`plugin` that augments the output of |Flake8| when passed
to :option:`flake8 --format`.
plugin
A package that is typically installed from PyPI to augment the
behaviour of |Flake8| either through adding one or more additional
:term:`check`\ s or providing additional :term:`formatter`\ s.
check
A piece of logic that corresponds to an error code. A check may
be a style check (e.g., check the length of a given line against
the user configured maximum) or a lint check (e.g., checking for
unused imports) or some other check as defined by a plugin.
error code
The symbol associated with a specific :term:`check`. For example,
pycodestyle implements :term:`check`\ s that look for whitespace
around binary operators and will either return an error code of
W503 or W504.

View file

@ -69,13 +69,14 @@ Alternatively, if you want to *ignore* only one specific warning or error:
Please read our user guide for more information about how to use and configure
|Flake8|.
FAQ
===
FAQ and Glossary
================
.. toctree::
:maxdepth: 2
faq
glossary
User Guide
==========
@ -127,3 +128,4 @@ General Indices
* :ref:`genindex`
* :ref:`Index of Documented Public Modules <modindex>`
* :ref:`Glossary of terms <glossary>`