mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-09 14:24:17 +00:00
Grammar and clarity improvements.
This commit is contained in:
parent
fd5c7d009d
commit
330fdb5b56
15 changed files with 45 additions and 45 deletions
|
|
@ -24,7 +24,7 @@ Remember that you want to specify certain options without writing
|
|||
Configuration Locations
|
||||
=======================
|
||||
|
||||
Presently, Flake8 supports storing its configuration in the following places:
|
||||
Flake8 supports storing its configuration in the following places:
|
||||
|
||||
- Your top-level user directory
|
||||
|
||||
|
|
@ -163,7 +163,7 @@ This would allow us to add comments for why we're excluding items, e.g.,
|
|||
:mod:`configparser` backport from PyPI. That backport enables us to
|
||||
support this behaviour on all supported versions of Python.
|
||||
|
||||
Please do **not** open issues about this dependency.
|
||||
Please do **not** open issues about this dependency to Flake8.
|
||||
|
||||
.. note::
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
By default, |Flake8| has a list of error codes that it ignores. The list used
|
||||
by a version of |Flake8| may be different than the list used by a different
|
||||
version. To determine the default list, using :option:`flake8 --help` will
|
||||
version. To see the default list, :option:`flake8 --help` will
|
||||
show the output with the current default list.
|
||||
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ specific error code on a specific line. Let's take for example a line like
|
|||
example = lambda: 'example'
|
||||
|
||||
Sometimes we genuinely need something this simple. We could instead define
|
||||
a function like we normally would but in some contexts that distracts from
|
||||
a function like we normally would. Note, in some contexts this distracts from
|
||||
what is actually happening. In those cases, we can also do:
|
||||
|
||||
.. code-block:: python
|
||||
|
|
|
|||
|
|
@ -2,13 +2,13 @@
|
|||
Using Flake8
|
||||
==============
|
||||
|
||||
Flake8 can be used in many ways:
|
||||
Flake8 can be used in many ways. A few:
|
||||
|
||||
- invoking it on the command-line
|
||||
- invoked on the command-line
|
||||
|
||||
- invoking it via Python
|
||||
- invoked via Python
|
||||
|
||||
- having it called by Git or Mercurial on or around committing
|
||||
- called by Git or Mercurial on or around committing
|
||||
|
||||
This guide will cover all of these and the nuances for using Flake8.
|
||||
|
||||
|
|
|
|||
|
|
@ -228,7 +228,7 @@
|
|||
- pylint
|
||||
|
||||
Other formatters can be installed. Refer to their documentation for the
|
||||
name to use to select them. Further, users can specify they're own format
|
||||
name to use to select them. Further, users can specify their own format
|
||||
string. The variables available are:
|
||||
|
||||
- code
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue