From 2d72fc23c804be2697446509e55234f8d96c00fe Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Sun, 6 Dec 2015 12:23:45 -0600 Subject: [PATCH] Add skeleton of DESIGN documentation --- DESIGN.rst | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 DESIGN.rst diff --git a/DESIGN.rst b/DESIGN.rst new file mode 100644 index 0000000..6f40e51 --- /dev/null +++ b/DESIGN.rst @@ -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 +-----------------------------------------------------