diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-06-08 11:48:36 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-06-08 11:48:36 -0500 |
| commit | 107f595d13fda6c76ad2ea218359d11209b5d4a4 (patch) | |
| tree | 6adae27c646235369800ba90dded0f8ac4ba73c1 /docs/source | |
| parent | e21628ad827c5f687ab0c3b5fc367351dfdfd743 (diff) | |
| download | flake8-107f595d13fda6c76ad2ea218359d11209b5d4a4.tar.gz | |
Add flake8.api and docs for it
Stub out the primary method people seem to use.
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/user/index.rst | 1 | ||||
| -rw-r--r-- | docs/source/user/python-api.rst | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst index 5e7503f..2ed779e 100644 --- a/docs/source/user/index.rst +++ b/docs/source/user/index.rst @@ -24,6 +24,7 @@ This guide will cover all of these and the nuances for using Flake8. configuration options ignoring-errors + python-api .. config files .. command-line tutorial diff --git a/docs/source/user/python-api.rst b/docs/source/user/python-api.rst new file mode 100644 index 0000000..2e2a16e --- /dev/null +++ b/docs/source/user/python-api.rst @@ -0,0 +1,11 @@ +=================== + Public Python API +=================== + +Flake8 3.0.0 presently does not have a public, stable Python API. + +When it does it will be located in :mod:`flake8.api` and that will +be documented here. + +.. automodule:: flake8.api + :members: |