diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst new file mode 100644 index 0000000..422da5e --- /dev/null +++ b/docs/source/glossary.rst @@ -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. diff --git a/docs/source/index.rst b/docs/source/index.rst index 55dfe3d..9fb02c0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 ` +* :ref:`Glossary of terms `