mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-13 08:04:18 +00:00
Add skeleton of DESIGN documentation
This commit is contained in:
commit
2d72fc23c8
1 changed files with 77 additions and 0 deletions
77
DESIGN.rst
Normal file
77
DESIGN.rst
Normal file
|
|
@ -0,0 +1,77 @@
|
||||||
|
==============
|
||||||
|
Design Goals
|
||||||
|
==============
|
||||||
|
|
||||||
|
Outline
|
||||||
|
-------
|
||||||
|
|
||||||
|
#. :ref:`plugins`
|
||||||
|
|
||||||
|
#. :ref:`checking`
|
||||||
|
|
||||||
|
#. :ref:`autofixing`
|
||||||
|
|
||||||
|
#. :ref:`options-passing`
|
||||||
|
|
||||||
|
#. :ref:`options`
|
||||||
|
|
||||||
|
#. :ref:`better-select-ignore`
|
||||||
|
|
||||||
|
#. :ref:`standard-in`
|
||||||
|
|
||||||
|
#. :ref:`multiprocessing`
|
||||||
|
|
||||||
|
#. :ref:`formatting`
|
||||||
|
|
||||||
|
#. :ref:`report-generation`
|
||||||
|
|
||||||
|
.. _plugins:
|
||||||
|
|
||||||
|
Better Plugins Support
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. _checking:
|
||||||
|
|
||||||
|
Support for Plugins that Only Run Checks
|
||||||
|
++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
.. _autofixing:
|
||||||
|
|
||||||
|
Support for Plugins that Autofix Errors
|
||||||
|
+++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
.. _options-passing:
|
||||||
|
|
||||||
|
Support for Plugins Require Parsed Options
|
||||||
|
++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
.. _options:
|
||||||
|
|
||||||
|
Better Options Support
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. _better-select-ignore:
|
||||||
|
|
||||||
|
Support for Better Select/Ignore Handling
|
||||||
|
+++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
.. _standard-in:
|
||||||
|
|
||||||
|
Better stdin support
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. _multiprocessing:
|
||||||
|
|
||||||
|
Multiprocessing Support
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. _formatting:
|
||||||
|
|
||||||
|
Better (Flake8-centralized) Formatting Support
|
||||||
|
----------------------------------------------
|
||||||
|
|
||||||
|
.. _report-generation:
|
||||||
|
|
||||||
|
|
||||||
|
Better (Flake8-centralized) Report Generation Support
|
||||||
|
-----------------------------------------------------
|
||||||
Loading…
Add table
Add a link
Reference in a new issue