Skip to content

Commit e408191

Browse files
committed
Added README documentation
1 parent 734b70e commit e408191

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
11
DocBlockr for Python
22
====================
3+
Based off the [DocBlockr](https://github.com/spadgos/sublime-jsdocs) project, This extension provides the similar funtionality but for python docstrings.
4+
This plugin is designed around [PEP-257](https://www.python.org/dev/peps/pep-0257/) compliance and takes from [Google's styleguide](https://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments).
5+
The main goal of this project is to help developer provide better documentation by giving easy and consistent formatting.
6+
7+
Installation
8+
------------
9+
[Package Control](https://sublime.wbond.net/installation)
10+
11+
1. Open Package Control: `Preferences -> Package Control`
12+
2. Select `Package Control: Install Package`
13+
3. Type `DocBlockr Python` into the search box and select the package to install it
14+
15+
Usage
16+
-----
17+
There isn't a key command to start this plugin, it is triggerg by hitting **enter** or **tab** after opening a docstring (`"""`) at the `module`, `class`, or `function` level.
18+
19+
20+
Known Issues
21+
------------
22+
- Doesn't detect if a docstring is already closed
23+
- Doesn't process module or class variables
24+
25+
Roadmap
26+
-------
27+
- Determine / Guess at variable and return value types
28+
- `Raises` section of documentation
29+
- `Decorators` section of documentation
30+
- Better README
31+
- Extended Python syntax with docstring keyword highlighting

0 commit comments

Comments
 (0)