https://github.com/sublimelinter/sublimelinter-pydocstyle
SublimeLinter plugin for python, using pydocstyle.
https://github.com/sublimelinter/sublimelinter-pydocstyle
Last synced: about 2 months ago
JSON representation
SublimeLinter plugin for python, using pydocstyle.
- Host: GitHub
- URL: https://github.com/sublimelinter/sublimelinter-pydocstyle
- Owner: SublimeLinter
- License: mit
- Created: 2013-12-15T21:43:24.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-04-24T10:27:16.000Z (10 months ago)
- Last Synced: 2025-04-24T11:32:25.425Z (10 months ago)
- Language: Python
- Homepage:
- Size: 46.9 KB
- Stars: 10
- Watchers: 8
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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.
## 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, 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).
1. Install `pydocstyle` by typing the following in a terminal:
```
[sudo] pip install pydocstyle
```
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