Skip to content

Commit 3e0cd1e

Browse files
committed
pre-spring cleaning
1 parent e0ab3db commit 3e0cd1e

File tree

2 files changed

+9
-47
lines changed

2 files changed

+9
-47
lines changed

README.md

Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ SublimeLinter-pydocstyle
33

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

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

88
## Installation
9-
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).
9+
SublimeLinter must be installed in order to use this plugin.
1010

11-
### Linter installation
12-
Before installing this plugin, you must ensure that `pep257` is installed on your system. To install `pep257`, do the following:
11+
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
12+
13+
Before installing this plugin, you must ensure that `pydocstyle` (0.3.0 or later) is installed on your system. To install `pydocstyle`, do the following:
1314

1415
1. Install [Python](http://python.org) and [pip](http://www.pip-installer.org/en/latest/installing.html).
1516

@@ -18,44 +19,8 @@ Before installing this plugin, you must ensure that `pep257` is installed on you
1819
[sudo] pip install pydocstyle
1920
```
2021

21-
**Note:** This plugin requires `pydocstyle` 0.3.0 or later.
22-
23-
### Linter configuration
24-
In order for `pydocstyle` 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.
25-
26-
Once `pydocstyle` is installed and configured, you can proceed to install the SublimeLinter-pydocstyle plugin if it is not yet installed.
27-
28-
### Plugin installation
29-
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.
30-
31-
To install via Package Control, do the following:
32-
33-
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.
34-
35-
1. When the plugin list appears, type `pydocstyle`. Among the entries you should see `SublimeLinter-pydocstyle`. If that entry is not highlighted, use the keyboard or mouse to select it.
22+
In order for `pydocstyle` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable).
3623

3724
## Settings
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-
40-
In addition to the standard SublimeLinter settings, SublimeLinter-pep257 provides its own setting which may also be used as an [inline override](http://www.sublimelinter.com/en/latest/settings.html#inline-overrides).
41-
42-
|Setting|Description|
43-
|:------|:----------|
44-
|add-ignore|A comma-separated list of error codes to add the the default ignore list|
45-
46-
## Contributing
47-
If you would like to contribute enhancements or fixes, please do the following:
48-
49-
1. Fork the plugin repository.
50-
1. Hack on a separate topic branch created from the latest `master`.
51-
1. Commit and push the topic branch.
52-
1. Make a pull request.
53-
1. Be patient. ;-)
54-
55-
Please note that modications should follow these coding guidelines:
56-
57-
- Indent is 4 spaces.
58-
- Code should pass flake8 and pydocstyle linters.
59-
- Vertical whitespace helps readability, don’t be afraid to use it.
60-
61-
Thank you for helping out!
25+
- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
26+
- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html

messages/install.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ SublimeLinter-pydocstyle
22
-------------------------------
33
This linter plugin for SublimeLinter provides an interface to pydocstyle.
44

5-
** IMPORTANT! **
6-
7-
Before this plugin will activate, you *must*
8-
follow the installation instructions here:
5+
Please read the installation instructions at:
96

107
https://github.com/SublimeLinter/SublimeLinter-pydocstyle

0 commit comments

Comments
 (0)