Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
braver committed Apr 2, 2018
1 parent 1e07c2a commit a2f5c70
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Expand Up @@ -3,14 +3,18 @@ SublimeLinter-pydocstyle

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

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.
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.


## Installation

SublimeLinter must be installed in order to use this plugin.

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

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

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

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

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


## Settings

- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html

0 comments on commit a2f5c70

Please sign in to comment.