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