summaryrefslogtreecommitdiff
path: root/docs/source/internal/index.rst
blob: a6a203ba938d8107674bba9312492158a36d97cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
==============================
 Exploring Flake8's Internals
==============================

While writing |Flake8| 3.0, the developers attempted to capture some reasoning
and decision information in internal documentation meant for future developers
and maintainers. Most of this information is unnecessary for users and plugin
developers. Some of it, however, is linked to from the plugin development
documentation.

Keep in mind that not everything will be here and you may need to help pull
information out of the developers' heads and into these documents. Please
pull gently.

.. toctree::
    :maxdepth: 2

    contributing
    writing-documentation
    writing-code
    releases
    start-to-finish
    checker
    cli
    formatters
    option_handling
    plugin_handling
    utils