diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/index.rst | 1 | ||||
| -rw-r--r-- | docs/source/internal/cli.rst | 26 |
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index c8a4f35..4d35951 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -27,6 +27,7 @@ Developer Guide .. toctree:: :maxdepth: 2 + internal/cli internal/formatters internal/option_handling internal/plugin_handling diff --git a/docs/source/internal/cli.rst b/docs/source/internal/cli.rst new file mode 100644 index 0000000..fc696bc --- /dev/null +++ b/docs/source/internal/cli.rst @@ -0,0 +1,26 @@ +Command Line Interface +====================== + +The command line interface of Flake8 is modeled as an application via +:class:`~flake8.main.cli.Application`. When a user runs ``flake8`` at their +command line, :func:`~flake8.main.cli.main` is run which handles +management of the application. + +User input is parsed *twice* to accomodate logging and verbosity options +passed by the user as early as possible so as much logging can be produced as +possible. + +The default flake8 options are registered by +:func:`~flake8.main.cli.register_default_options`. Trying to register these +options in plugins will result in errors. + + +API Documentation +----------------- + +.. autofunction:: flake8.main.cli.main + +.. autoclass:: flake8.main.cli.Application + :members: + +.. autofunction:: flake8.main.cli.register_default_options |