a Sublime Text 2 plugin to automatic generate docstring for module/class/function
Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
README.md
class_docstring.PNG
docstring.py
function_docstring.PNG
module_docstring.PNG

README.md

Sublime-Text-3-pydocstring

a Sublime Text 3 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 3 > 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