Add skeleton of DESIGN documentation

This commit is contained in:
Ian Cordasco 2015-12-06 12:23:45 -06:00
commit 2d72fc23c8

77
DESIGN.rst Normal file
View 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
-----------------------------------------------------