Skip to content

Commit a2f5c70

Browse files
committed
update readme
1 parent 1e07c2a commit a2f5c70

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@ 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](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.
6+
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [pydocstyle](https://github.com/PyCQA/pydocstyle).
7+
It will be used with files that have the "Python" syntax.
8+
79

810
## Installation
11+
912
SublimeLinter must be installed in order to use this plugin.
1013

1114
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
1215

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:
16+
Before installing this plugin, ensure that `pydocstyle` (0.3.0 or later) is installed on your system.
17+
To install `pydocstyle`, do the following:
1418

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

@@ -19,8 +23,11 @@ Before installing this plugin, you must ensure that `pydocstyle` (0.3.0 or later
1923
[sudo] pip install pydocstyle
2024
```
2125

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.com/en/latest/troubleshooting.html#finding-a-linter-executable).
26+
Please make sure that the path to `pydocstyle` is available to SublimeLinter.
27+
The docs cover [troubleshooting PATH configuration](http://sublimelinter.com/en/latest/troubleshooting.html#finding-a-linter-executable).
28+
2329

2430
## Settings
31+
2532
- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
2633
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html

0 commit comments

Comments
 (0)