pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-08 14:04:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use |Flake8| consistently throughout documentation

Browse source
This commit is contained in:
Ian Cordasco 2016-06-20 08:13:50 -05:00
parent 57ac6ab699
commit 41277ff965
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
19 changed files with 192 additions and 167 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/source/user/invocation.rst
View file

@ -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