mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-05 04:36:52 +00:00
Add documentation around the cli
This commit is contained in:
parent
a82f8cb580
commit
414922d08e
4 changed files with 101 additions and 5 deletions
|
|
@ -27,6 +27,7 @@ Developer Guide
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
internal/cli
|
||||
internal/formatters
|
||||
internal/option_handling
|
||||
internal/plugin_handling
|
||||
|
|
|
|||
26
docs/source/internal/cli.rst
Normal file
26
docs/source/internal/cli.rst
Normal file
|
|
@ -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
|
||||
Loading…
Add table
Add a link
Reference in a new issue