mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-31 03:06:53 +00:00
Add flake8.api and docs for it
Stub out the primary method people seem to use.
This commit is contained in:
parent
e21628ad82
commit
107f595d13
3 changed files with 22 additions and 0 deletions
|
|
@ -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
|
||||
|
|
|
|||
11
docs/source/user/python-api.rst
Normal file
11
docs/source/user/python-api.rst
Normal file
|
|
@ -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:
|
||||
10
flake8/api.py
Normal file
10
flake8/api.py
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
"""Module containing all public entry-points for Flake8.
|
||||
|
||||
This is the only submodule in Flake8 with a guaranteed stable API. All other
|
||||
submodules are considered internal only and are subject to change.
|
||||
"""
|
||||
|
||||
|
||||
def get_style_guide(**kwargs):
|
||||
"""Stub out the only function I'm aware of people using."""
|
||||
pass
|
||||
Loading…
Add table
Add a link
Reference in a new issue