This is a simple VSCode extension which helps in adding Docstrings to your python code. Currently docstrings for Functions
and Classes
are supported.
Add elaborated Docstrings to your python code!
Currently Supports docstrings for:
- Functions - with/without arguments and keyword arguments
- Class
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 hitEnter
Tip: Please refer the below GIF for a demo
Add new shortcut to generate docstring. Selecting the function/class and pressing ctrl+alt+b
generates the doctstring.
Upgrade tar
to get latest security patch for issue - CVE-2018-20834
Upgrade node.extend
to get latest security patch
Fix indentation issue with closing doc string
Add categories to extension
Add icon to extension
Initial release of PyDoc extension for VS Code
Enjoy!