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