diff options
| author | MaxPayton <iamaspacecow@gmail.com> | 2016-06-02 16:29:56 -0700 |
|---|---|---|
| committer | MaxPayton <iamaspacecow@gmail.com> | 2016-06-03 16:27:22 -0700 |
| commit | 26c64badd9ea27cbfbff311f7b3b09b475e80ead (patch) | |
| tree | beb66d04e460f12536935221dcc1dadec30bf8c3 /docs | |
| parent | b02d7687ee4de8f501195644bc9dc7fac523e52e (diff) | |
| download | pep8-26c64badd9ea27cbfbff311f7b3b09b475e80ead.tar.gz | |
Change all references to the pep8 project to say pycodestyle
This fixes issue #518, pep8 still referenced in the cli help command
As a side effect, `[pep8]` in setup.cfg now becomes `[pycodestyle]`
Also, changed the path for the config file from ~/.config/pep8 to ~/.config/pycodestyle
These feel like changes that should have come with the jump to version 2.0.0, as they are breaking,
but support for as a name can still be added if it's desired enough
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/intro.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/intro.rst b/docs/intro.rst index 12f67d7..ce71692 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -167,13 +167,14 @@ Quick help is available on the command line:: --benchmark measure processing speed Configuration: - The project options are read from the [pep8] section of the tox.ini - file or the setup.cfg file located in any parent folder of the path(s) - being processed. Allowed options are: exclude, filename, select, + The project options are read from the [pycodestyle] section of the + tox.ini file or the setup.cfg file located in any parent folder of the + path(s) being processed. Allowed options are: exclude, filename, select, ignore, max-line-length, hang-closing, count, format, quiet, show-pep8, show-source, statistics, verbose. - --config=path user config file location (default: ~/.config/pep8) + --config=path user config file location + (default: ~/.config/pycodestyle) Configuration @@ -184,23 +185,23 @@ The behaviour may be configured at two levels, the user and project levels. At the user level, settings are read from the following locations: If on Windows: - ``~\.pep8`` + ``~\.pycodestyle`` Otherwise, if the :envvar:`XDG_CONFIG_HOME` environment variable is defined: - ``XDG_CONFIG_HOME/pep8`` + ``XDG_CONFIG_HOME/pycodestyle`` Else if :envvar:`XDG_CONFIG_HOME` is not defined: - ``~/.config/pep8`` + ``~/.config/pycodestyle`` Example:: - [pep8] + [pycodestyle] ignore = E226,E302,E41 max-line-length = 160 At the project level, a ``setup.cfg`` file or a ``tox.ini`` file is read if -present. If none of these files have a ``[pep8]`` section, no project specific -configuration is loaded. +present. If none of these files have a ``[pycodestyle]`` section, no project +specific configuration is loaded. Error codes |