File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ {
2+ "install" : " messages/install.txt"
3+ }
Original file line number Diff line number Diff line change 1+ DocBlockr Python
2+ ================
3+
4+ To get started:
5+
6+ 1. Open a python file (syntax must be currently set to python)
7+ 2. Open a double quoted docstring (""") at one of the following places:
8+ - Top of the file
9+ - Beginning of a class
10+ - Beginning of a function
11+ 3. Press [enter] to trigger the autocomplete
12+
13+ If you don't want to trigger the parser on a docstring, simply hold down [ctrl]/[cmd] and press [enter]
14+
15+ For configuration and extendability, see the readme
16+ https://github.com/adambullmer/sublime_docblockr_python
17+
18+ Examples
19+ --------
20+
21+ 1.
22+ class TestClass():
23+ """<-- Press [enter]
24+
25+ 2.
26+ def test_function():
27+ """<-- Press [enter]
Original file line number Diff line number Diff line change 22 "schema_version" : " 3.0.0" ,
33 "dependencies" : [],
44 "packages" : [{
5- "name" : " DocBlockr_Python " ,
5+ "name" : " DocBlockr Python " ,
66 "details" : " https://github.com/adambullmer/sublime_docblockr_python" ,
77 "readme" : " https://raw.githubusercontent.com/adambullmer/sublime_docblockr_python/master/README.md" ,
88 "issues" : " https://github.com/adambullmer/sublime_docblockr_python/issues" ,
You can’t perform that action at this time.
0 commit comments