diff options
| author | Cea Stapleton <ceaess@gmail.com> | 2016-06-19 14:06:26 -0500 |
|---|---|---|
| committer | Cea Stapleton <ceaess@gmail.com> | 2016-06-19 14:06:26 -0500 |
| commit | 330fdb5b5623e09151a4c6576cb3738563c13769 (patch) | |
| tree | 61edc56a4a11f223cf464eca58ad2eed2bc2c0ff /docs/source/dev | |
| parent | fd5c7d009df0a40377a7cf0826195d72c4521f07 (diff) | |
| download | flake8-330fdb5b5623e09151a4c6576cb3738563c13769.tar.gz | |
Grammar and clarity improvements.
Diffstat (limited to 'docs/source/dev')
| -rw-r--r-- | docs/source/dev/formatters.rst | 2 | ||||
| -rw-r--r-- | docs/source/dev/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/dev/registering_plugins.rst | 6 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/source/dev/formatters.rst b/docs/source/dev/formatters.rst index 5307e75..5beafda 100644 --- a/docs/source/dev/formatters.rst +++ b/docs/source/dev/formatters.rst @@ -4,7 +4,7 @@ Developing a Formatting Plugin for Flake8 =========================================== -Flake8 added the ability to develop custom formatting plugins in version +Flake8 allowed for custom formatting plugins in version 3.0.0. Let's write a plugin together: .. code-block:: python diff --git a/docs/source/dev/index.rst b/docs/source/dev/index.rst index 43f01c1..4969395 100644 --- a/docs/source/dev/index.rst +++ b/docs/source/dev/index.rst @@ -4,9 +4,9 @@ Since Flake8 2.0, the Flake8 tool has allowed for extensions and custom plugins. In Flake8 3.0, we're expanding that ability to customize and -extend **and** we're attempting to thoroughly document it too. Some of the +extend **and** we're attempting to thoroughly document it. Some of the documentation in this section will reference third-party documentation -in order to reduce duplication and to point you, the developer, towards +to reduce duplication and to point you, the developer, towards the authoritative documentation for those pieces. .. toctree:: diff --git a/docs/source/dev/registering_plugins.rst b/docs/source/dev/registering_plugins.rst index 0cc18d9..53b6dc4 100644 --- a/docs/source/dev/registering_plugins.rst +++ b/docs/source/dev/registering_plugins.rst @@ -4,9 +4,9 @@ Registering a Plugin with Flake8 ================================== -To register any kind of plugin with Flake8, you need a few things: +To register any kind of plugin with Flake8, you need: -#. You need a way to install the plugin (whether it is packaged on its own or +#. A way to install the plugin (whether it is packaged on its own or as part of something else). In this section, we will use a ``setup.py`` written for an example plugin. @@ -15,7 +15,7 @@ To register any kind of plugin with Flake8, you need a few things: #. A somewhat recent version of setuptools (newer than 0.7.0 but preferably as recent as you can attain). -Flake8 presently relies on a functionality provided by setuptools called +Flake8 relies on functionality provided by setuptools called `Entry Points`_. These allow any package to register a plugin with Flake8 via that package's ``setup.py`` file. |
