DocBlockr_Python

by thep0y ST4

Sublime Text DocBlockr for python. Simplifies writing docstring comments in Python.

Labels python, docstring, automatic, formatter, generator, auto-complete, snippets

Details

Version 1.8.5
Homepage github.com
Issues github.com
Modified 2 years ago
Last Seen 30 minutes ago
First Seen 9 years ago

Installs

Total 52K
Win 33K
Mac 9K
Linux 9K

	Nov 21	Nov 20	Nov 19	Nov 18	Nov 17	Nov 16	Nov 15	Nov 14	Nov 13	Nov 12	Nov 11	Nov 10	Nov 9	Nov 8	Nov 7	Nov 6	Nov 5	Nov 4	Nov 3	Nov 2	Nov 1	Oct 31	Oct 30	Oct 29	Oct 28	Oct 27	Oct 26	Oct 25	Oct 24	Oct 23	Oct 22	Oct 21	Oct 20	Oct 19	Oct 18	Oct 17	Oct 16	Oct 15	Oct 14	Oct 13	Oct 12	Oct 11	Oct 10	Oct 9	Oct 8	Oct 7
Windows	2	0	0	2	1	1	0	0	0	2	3	1	0	4	4	2	2	4	2	0	4	3	4	1	2	2	1	1	5	3	1	0	2	1	0	3	2	2	2	0	2	1	5	1	1	1
Mac	0	0	0	0	0	0	0	0	0	0	0	0	1	1	1	1	2	1	0	1	0	1	2	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	1	0	0	0	1	0	0	0
Linux	0	0	4	0	0	0	1	0	0	1	0	1	1	1	0	1	1	1	0	0	1	3	0	0	0	0	0	0	0	2	0	0	0	0	0	0	0	1	0	0	0	0	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-package file.
Move this file to your Installed Packages directory. (Preferences > Browse Packages... and go up one directory to see Installed 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
Google
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

Doc​Blockr_Python