Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
a Sublime Text 2 plugin to automatic generate docstring for module/class/function
Python
branch: master

fix bugs when generate class docstring

 - fix bugs when generate class docstring
 - remove unneeded line feed in docstring
latest commit 6480536339
@JerryKwan authored

README.md

Sublime-Text-2-pydocstring

a Sublime Text 2 plugin to automatic generate docstring for module/class/function

docstring.py

docstring.py is a python docstring plugin, you can use this plugin to generate docstring for the module, class or function automatically.

Installation

Copy docstring.py into your ST2 User packages folder (Sublime Text 2 > Preferences > Browse Packages... > User)

Usage

Click on the position you want to generate docstring, but do not select anything, you could define key bindings or menu entries to use this plugin easy and quick

I've added this to my User Key Bindings:

 {"keys": ["ctrl+alt+s"], "command": "docstring"}

...and this to Context.sublime-menu, which allow context menu access:

 { "command": "docstring", "caption": "Generate Docstring"}

module screenshop

class screenshop

function screenshop

Something went wrong with that request. Please try again.