summaryrefslogtreecommitdiff
path: root/docs/source/user/invocation.rst
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-06-20 08:13:50 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-06-20 08:13:50 -0500
commit41277ff965b9083d898ad8c2c990f7c119a8a1ae (patch)
tree1e0256830f12b7895d8b83b5f2173cfed08174d1 /docs/source/user/invocation.rst
parent57ac6ab6994dc609a3514f49d77dac228328d308 (diff)
downloadflake8-41277ff965b9083d898ad8c2c990f7c119a8a1ae.tar.gz
Use |Flake8| consistently throughout documentation
Diffstat (limited to 'docs/source/user/invocation.rst')
-rw-r--r--docs/source/user/invocation.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/source/user/invocation.rst b/docs/source/user/invocation.rst
index ef763ae..5c92ca3 100644
--- a/docs/source/user/invocation.rst
+++ b/docs/source/user/invocation.rst
@@ -4,16 +4,16 @@
Invoking Flake8
=================
-Once you have :ref:`installed <installation-guide>` Flake8, you can begin
-using it. Most of the time, you will be able to generically invoke Flake8
+Once you have :ref:`installed <installation-guide>` |Flake8|, you can begin
+using it. Most of the time, you will be able to generically invoke |Flake8|
like so:
.. prompt:: bash
flake8 ...
-Where you simply allow the shell running in your terminal to locate Flake8.
-In some cases, though, you may have installed Flake8 for multiple versions
+Where you simply allow the shell running in your terminal to locate |Flake8|.
+In some cases, though, you may have installed |Flake8| for multiple versions
of Python (e.g., Python 2.7 and Python 3.5) and you need to call a specific
version. In that case, you will have much better results using:
@@ -27,15 +27,15 @@ Or
python3.5 -m flake8
-Since that will tell the correct version of Python to run Flake8.
+Since that will tell the correct version of Python to run |Flake8|.
.. note::
- Installing Flake8 once will not install it on both Python 2.7 and
+ Installing |Flake8| once will not install it on both Python 2.7 and
Python 3.5. It will only install it for the version of Python that
is running pip.
-It is also possible to specify command-line options directly to Flake8:
+It is also possible to specify command-line options directly to |Flake8|:
.. prompt:: bash
@@ -53,7 +53,7 @@ Or
From now on, we'll simply use ``flake8`` and assume that the user
knows they can instead use ``python<version> -m flake8`` instead.
-It's also possible to narrow what Flake8 will try to check by specifying
+It's also possible to narrow what |Flake8| will try to check by specifying
exactly the paths and directories you want it to check. Let's assume that
we have a directory with python files and subdirectories which have python
files (and may have more sub-directories) called ``my_project``. Then if