PyDoc README

This is a simple VSCode extension which helps in adding Docstrings to your python code. Currently docstrings for Functions and Classes are supported.

Features

Add elaborated Docstrings to your python code!

Currently Supports docstrings for:

• Functions - with/without arguments and keyword arguments
• Class

Extension Settings

After you have installed the extension:

• Select the function/class that you want to write the docstring for
• Hit Ctrl+Shift+P which brings up the command palette
• Select Docstring and hit Enter

Tip: Please refer the below GIF for a demo

Release Notes

0.4.0

Add new shortcut to generate docstring. Selecting the function/class and pressing ctrl+alt+b generates the doctstring.

0.3.3

Upgrade tar to get latest security patch for issue - CVE-2018-20834

0.3.2

Upgrade node.extend to get latest security patch

0.3.1

Fix indentation issue with closing doc string

0.3.0

Add categories to extension

0.2.0

Add icon to extension

0.1.0

Initial release of PyDoc extension for VS Code

Enjoy!