Skip to content

Commit 65ff0d1

Browse files
committed
Documentation updates.
1 parent ebca42f commit 65ff0d1

4 files changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ SublimeLinter-pep8
44
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter3) provides an interface to the [pep8](https://github.com/jcrocholl/pep8). It will be used with files that have the “Python” syntax.
55

66
## Installation
7+
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](https://github.com/SublimeLinter/SublimeLinter.github.io/wiki/Installation).
78

89
### Linter installation
910
Before installing this plugin, you must ensure that `pep8` is installed on your system. To install `pep8`, do the following:
@@ -15,7 +16,7 @@ Before installing this plugin, you must ensure that `pep8` is installed on your
1516
[sudo] pip-3.x install pep8
1617
```
1718

18-
Now you can proceed to install the SublimeLinter-pep8 plugin.
19+
Once pep8 is installed, you can proceed to install the SublimeLinter-pep8 plugin if it is not yet installed.
1920

2021
### Plugin installation
2122
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.
@@ -35,7 +36,7 @@ In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides
3536
|:------|:----------|:------------:|:-------------:|
3637
|ignore|A comma-separated list of error codes to ignore| |✓|
3738
|select|A comma-separated list of error codes to select, overrides ignore| |✓|
38-
|max-line-length|The maximum allowed line length. `null` allows any length.|✓| |
39+
|max-line-length|The maximum allowed line length. `null` uses the PEP8 default of 79.|✓| |
3940

4041
## Contributing
4142
If you would like to contribute enhancements or fixes, please do the following:

messages.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"install": "messages/install.txt"
2+
"install": "messages/install.txt",
3+
"1.0.2": "messages/1.0.2.txt"
34
}

messages/1.0.2.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
SublimeLinter-pep8 1.0.2
2+
-------------------------
3+
4+
Please note that using null for max-line-length does NOT
5+
disable max-line-length, but uses the PEP8 default of 79.
6+
7+
To disable max-line-length completely, add "E501" to the
8+
"ignore" setting.

messages/install.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
SublimeLinter-pep8
22
-------------------------------
3-
43
This linter plugin for SublimeLinter provides an interface to pep8.
54

6-
For more information, please see https://github.com/SublimeLinter/SublimeLinter-pep8.
5+
INSTALLATION
6+
------------
7+
Before this plugin will activate, you *must* follow the installation
8+
instructions here:
9+
10+
https://github.com/SublimeLinter/SublimeLinter-pep8

0 commit comments

Comments
 (0)