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