Skip to content

Commit ab47400

Browse files
committed
Make it easier to get started adjusting PEP8
1 parent 8d8942e commit ab47400

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,43 @@ In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides
4545
|select|A comma-separated list of error codes to select, overrides ignore| |✓|
4646
|max-line-length|The maximum allowed line length. `null` uses the PEP8 default of 79.|✓| |
4747

48+
### Settings quick start
49+
50+
One way to adjust linting settings for your preferences is to use Sublime Text project functionality.
51+
This is to avoid extraneous red markers all over your source code files, when pep8 kicks in and some of your coding style does not suit for pep8. A Sublime Text project consists of working folders and settings applied when editing the project files.
52+
53+
* Create a Sublime Text project (*Project* -> *New workspace for a project*)
54+
55+
* Then edit project settings (*Project* -> *Edit project*)
56+
57+
* Drop in your preferences for the Python interpreter and linting settings. An example below:
58+
59+
{
60+
"SublimeLinter":
61+
{
62+
"@python": 2.7,
63+
"linters":
64+
{
65+
"pep8":
66+
{
67+
"@disable": false,
68+
"ignore": "E501,E128,E127",
69+
"max-line-length": 512
70+
}
71+
}
72+
},
73+
"build_systems":
74+
...
75+
}
76+
77+
* You will find pep8 error codes from Sublime Text console (*View* -> *Show Console*). Put ones you wish to disable to `ignore` setting
78+
79+
* Save the settings file
80+
81+
* Edit and save any Python source code file and you should see the new linting settings to take effect
82+
83+
* You can add any number for working folders to the project with *Project* -> *Add Folder to Project*
84+
4885
## Contributing
4986
If you would like to contribute enhancements or fixes, please do the following:
5087

0 commit comments

Comments
 (0)