# SublimeLinter-pydocstyle

**Repository Path**: yunduozhai/SublimeLinter-pydocstyle

## Basic Information

- **Project Name**: SublimeLinter-pydocstyle
- **Description**: SublimeLinter plugin for python, using pydocstyle.fork from "SublimeLinter/SublimeLinter-pydocstyle"
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-26
- **Last Updated**: 2024-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Sublime-text

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