Skip to content

Commit d9e3c08

Browse files
author
Evan R. Giordanella
committed
updating readme to reflect pycodestyle
1 parent c4f6efd commit d9e3c08

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@ SublimeLinter-pep8
33

44
[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-pep8.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-pep8)
55

6-
This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to [pep8](https://github.com/jcrocholl/pep8). It will be used with files that have the “Python” syntax.
6+
This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to [pycodestyle](https://github.com/PyCQA/pycodestyle). It will be used with files that have the “Python” syntax.
77

88
## Installation
99
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](http://sublimelinter.readthedocs.org/en/latest/installation.html).
1010

1111
### Linter installation
12-
Before installing this plugin, you must ensure that `pep8` is installed on your system. To install `pep8`, do the following:
12+
Before installing this plugin, you must ensure that `pycodestyle` is installed on your system. To install `pycodestyle`, do the following:
1313

1414
1. For best performance, install [Python 3](http://python.org) and [pip](http://www.pip-installer.org/en/latest/installing.html).
1515

16-
1. Install `pep8` by typing the following in a terminal, replacing '3.x' with the available version of pip:
16+
1. Install `pycodestyle` by typing the following in a terminal, replacing '3.x' with the available version of pip:
1717
```
18-
[sudo] pip-3.x install pep8
18+
[sudo] pip-3.x install pycodestyle
1919
```
2020

21-
**Note:** This plugin requires `pep8` 1.4.6 or later.
21+
**Note:** This plugin requires `pycodestyle` 1.4.6 or later.
2222

2323
### Linter configuration
24-
In order for `pep8` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in [“Finding a linter executable”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
24+
In order for `pycodestyle` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in [“Finding a linter executable”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
2525

26-
Once `pep8` is installed and configured, you can proceed to install the SublimeLinter-pep8 plugin if it is not yet installed.
26+
Once `pycodestyle` is installed and configured, you can proceed to install the SublimeLinter-pycodestyle plugin if it is not yet installed.
2727

2828
### Plugin installation
2929
Please use [Package Control](https://sublime.wbond.net/installation) to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
@@ -32,12 +32,12 @@ To install via Package Control, do the following:
3232

3333
1. Within Sublime Text, bring up the [Command Palette](http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html) and type `install`. Among the commands you should see `Package Control: Install Package`. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
3434

35-
1. When the plugin list appears, type `pep8`. Among the entries you should see `SublimeLinter-pep8`. If that entry is not highlighted, use the keyboard or mouse to select it.
35+
1. When the plugin list appears, type `pycodestyle`. Among the entries you should see `SublimeLinter-pycodestyle`. If that entry is not highlighted, use the keyboard or mouse to select it.
3636

3737
## Settings
3838
For general information on how SublimeLinter works with settings, please see [Settings](http://sublimelinter.readthedocs.org/en/latest/settings.html). For information on generic linter settings, please see [Linter Settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
3939

40-
In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline](http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings).
40+
In addition to the standard SublimeLinter settings, SublimeLinter-pycodestyle provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline](http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings).
4141

4242
|Setting|Description|Inline Setting|Inline Override|
4343
|:------|:----------|:------------:|:-------------:|
@@ -46,7 +46,7 @@ In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides
4646
|max-line-length|The maximum allowed line length. `null` uses the PEP8 default of 79.|✓| |
4747

4848
### Implementing per-project settings
49-
Typically you will want to configure pep8 on a per-project basis to conform to the coding style for all files in that project. Usually you want to ignore certain pep8 warnings. First you need to find the pep8 error codes from the [pep8 documentation](http://pep8.readthedocs.org/en/latest/intro.html#error-codes). Then you need to configure the pep8 linter to ignore those warnings.
49+
Typically you will want to configure pycodestyle on a per-project basis to conform to the coding style for all files in that project. Usually you want to ignore certain pycodestyle warnings. First you need to find the pycodestyle error codes from the [pycodestyle documentation](http://pep8.readthedocs.org/en/latest/intro.html#error-codes). Then you need to configure the pep8 linter to ignore those warnings.
5050

5151
For example, let’s say your project requires python 2.7+, you want the maximum line length to be 512, and you want to ignore warnings about visual indents (pep8 errors E127 and E128):
5252

@@ -61,7 +61,7 @@ For example, let’s say your project requires python 2.7+, you want the maximum
6161
"@python": 2.7,
6262
"linters":
6363
{
64-
"pep8":
64+
"pycodestyle":
6565
{
6666
"@disable": false,
6767
"ignore": "E127,E128",

0 commit comments

Comments
 (0)