ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Doc​Blockr_Python

by thep0y ST4

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

Details

Installs

  • Total 51K
  • Win 33K
  • Mac 9K
  • Linux 9K
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 Jun 2 Jun 1 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
Windows 0 1 2 1 1 0 1 1 3 4 2 4 4 1 0 1 0 0 1 1 0 3 0 2 1 1 1 1 0 4 3 3 1 0 3 0 0 0 1 2 0 0 3 4 2 1
Mac 0 0 0 0 0 0 0 0 1 0 0 0 2 1 0 0 0 0 0 0 0 0 1 1 1 0 0 0 1 0 0 1 1 0 0 0 0 0 1 0 0 0 0 1 0 0
Linux 0 0 1 0 0 0 0 1 0 1 1 2 0 1 0 0 0 1 0 0 0 0 1 0 0 0 2 0 0 0 1 0 1 0 0 0 1 0 2 0 0 0 1 0 1 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

  1. Go to the Latest Release and download the python-docblockr.sublime-package file.
  2. Move this file to your Installed Packages directory. (Preferences > Browse Packages... and go up one directory to see Installed Packages)
  3. 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

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