From c2111656a6776d2f85164d0a8e609ae6271c3054 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Fri, 24 Jun 2016 14:54:48 -0500 Subject: [PATCH] Add descriptions of pycodestyle and mccable --- docs/source/glossary.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index f3231fc..dd691b6 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -41,6 +41,16 @@ errors. pyflakes - The project |Flake8| depends upon to lint files (check for unused + The project |Flake8| depends on to lint files (check for unused imports, variables, etc.). This uses the ``F`` :term:`class` of :term:`error code`\ s reported by |Flake8|. + + pycodestyle + The project |Flake8| depends on to provide style enforcement. + pycodestyle implements :term:`check`\ s for :pep:`8`. This uses the + ``E`` and ``W`` :term:`class`\ es of :term:`error code`\ s. + + mccabe + The project |Flake8| depends on to calculate the McCabe complexity + of a unit of code (e.g., a function). This uses the ``C`` + :term:`class` of :term`error code`\ s.