You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-53Lines changed: 1 addition & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,56 +37,4 @@ To install via Package Control, do the following:
37
37
## Settings
38
38
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).
39
39
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).
|ignore|A comma-separated list of error codes to ignore||✓|
45
-
|select|A comma-separated list of error codes to select, overrides ignore||✓|
46
-
|max-line-length|The maximum allowed line length. `null` uses the PEP8 default of 79.|✓||
47
-
48
-
### Implementing per-project settings
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.
50
-
51
-
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):
52
-
53
-
* If you have not already created a project in Sublime Text, select `Project -> Save Project As...`.
54
-
55
-
* Select `Project -> Edit Project`.
56
-
57
-
* At the **top** level of the project’s JSON data, add the following:
58
-
59
-
"SublimeLinter":
60
-
{
61
-
"@python": 2.7,
62
-
"linters":
63
-
{
64
-
"pycodestyle":
65
-
{
66
-
"@disable": false,
67
-
"ignore": "E127,E128",
68
-
"max-line-length": 512
69
-
}
70
-
}
71
-
}
72
-
73
-
* Save the file.
74
-
75
-
Any time you edit the project and change a linter’s settings, all open files that use that linter will be re-linted to reflect the new settings.
76
-
77
-
## Contributing
78
-
If you would like to contribute enhancements or fixes, please do the following:
79
-
80
-
1. Fork the plugin repository.
81
-
1. Hack on a separate topic branch created from the latest `master`.
82
-
1. Commit and push the topic branch.
83
-
1. Make a pull request.
84
-
1. Be patient. ;-)
85
-
86
-
Please note that modications should follow these coding guidelines:
87
-
88
-
- Indent is 4 spaces.
89
-
- Code should pass flake8 and pep257 linters.
90
-
- Vertical whitespace helps readability, don’t be afraid to use it.
91
-
92
-
Thank you for helping out!
40
+
In addition to the standard SublimeLinter settings, SublimeLinter-pycodestyle provides its own settings.
0 commit comments