DocBlockr_Python
Sublime Text DocBlockr for python. Simplifies writing docstring comments in Python.
Details
Installs
- Total 50K
- Win 32K
- Mac 9K
- Linux 9K
| Feb 5 | Feb 4 | Feb 3 | Feb 2 | Feb 1 | Jan 31 | Jan 30 | Jan 29 | Jan 28 | Jan 27 | Jan 26 | Jan 25 | Jan 24 | Jan 23 | Jan 22 | Jan 21 | Jan 20 | Jan 19 | Jan 18 | Jan 17 | Jan 16 | Jan 15 | Jan 14 | Jan 13 | Jan 12 | Jan 11 | Jan 10 | Jan 9 | Jan 8 | Jan 7 | Jan 6 | Jan 5 | Jan 4 | Jan 3 | Jan 2 | Jan 1 | Dec 31 | Dec 30 | Dec 29 | Dec 28 | Dec 27 | Dec 26 | Dec 25 | Dec 24 | Dec 23 | Dec 22 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 1 | 6 | 4 | 6 | 1 | 0 | 4 | 6 | 2 | 2 | 2 | 2 | 3 | 3 | 3 | 5 | 3 | 5 | 1 | 4 | 3 | 2 | 1 | 2 | 2 | 4 | 6 | 6 | 3 | 1 | 3 | 4 | 1 | 3 | 1 | 1 | 2 | 0 | 8 | 1 | 1 | 2 | 1 | 0 | 1 | 2 |
| Mac | 1 | 0 | 1 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | 2 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 1 |
| Linux | 0 | 1 | 0 | 0 | 1 | 1 | 2 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 1 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 2 | 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