DocBlockr_Python
Sublime Text DocBlockr for python. Simplifies writing docstring comments in Python.
Details
Installs
- Total 51K
- Win 33K
- Mac 9K
- Linux 9K
| Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | Aug 18 | Aug 17 | Aug 16 | Aug 15 | Aug 14 | Aug 13 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 1 | 2 | 3 | 2 | 2 | 2 | 2 | 2 | 0 | 3 | 2 | 1 | 1 | 2 | 1 | 3 | 0 | 5 | 1 | 0 | 2 | 2 | 4 | 3 | 0 | 0 | 2 | 3 | 2 | 5 | 1 | 6 | 1 | 0 | 3 | 2 | 1 | 2 | 0 | 1 | 1 | 1 | 6 | 3 | 3 | 5 |
| Mac | 0 | 2 | 1 | 0 | 0 | 4 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | 2 | 1 | 2 | 1 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 2 | 2 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 |
| Linux | 1 | 2 | 1 | 1 | 1 | 2 | 1 | 1 | 0 | 2 | 1 | 0 | 0 | 2 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 0 | 0 | 1 |
Readme
- Source
- raw.githubusercontent.com
DocBlockr for Python
Based off the DocBlockr project, This extension provides the similar funtionality but for python docstrings. The default formatter for this plugin is designed around PEP-257 compliance but with more verbosity: Added variable types, listing class extensions, and listing decorators. The main goal of this project is to help developer provide better documentation by giving easy and consistent formatting.
Installation
Manually Download the release and put it in your installed packages directory yourself
- Go to the Latest Release and download the
python-docblockr.sublime-packagefile. - Move this file to your
Installed Packagesdirectory. (Preferences > Browse Packages...and go up one directory to seeInstalled Packages) - If you are updating your existing install, a restart of Sublime Text will be in order.
Usage
There isn't a command pallete command to start this plugin, it is triggerg by hitting enter or tab after opening a docstring (""") at the module, class, or function level.
If you wanted to simply put a new line after opening a docstring and not trigger the formatter, just hold ctrl and press enter.
Default and User Settings
You can configure which docstring format to use by updating your user settings for this package (Preferences > Package Settings > Python DocBlockr > Settings).
Project Settings
You can also override your user settings on a per project basis by editing your project file. Any setting will be available for overriding here.
{
"PythonDocblockr": {
"formatter": "sphinx"
},
"folders": [
// ...
]
}
Supported Docstring Styles
- Docblockr (PEP0257 with types)
- PEP0257
- Numpy
- Sphinx (reST)
Known Issues
- Only detects closed docstring if it is on a line of the same indentation, and has no text in front of it. Single Line docstrings are converted to block