Python Visual Studio Code autoDocstring Configuration

python visual-studio-code vscode-settings docstring
syth3 picture syth3 · Aug 7, 2018 · Viewed 7.7k times · Source

Goal: generate docstring in vscode for Python automatically and format the generated docstring to my liking.

Solution: I installed the autoDocstring extension.

Problem: I don't know how to get the generated docstring to be formatted the way I want it. In the description under the "Extension Settings" heading, it seems to suggest that you can change the default format with the "autoDocstring.docstringFormat" setting. My question is, how does one configure that setting? I've looked around and cannot find a solution.

Answer

Roger Veciana picture Roger Veciana · Sep 28, 2018

You have to go to:

File > Preferences > Settings in Windows/Linux

Code > Preferences > Settings in Mac

Then choose at the right side of the open document if you want to change the configuration for all the user sessions or only this workspace.

The workspace case would be:

{
    "autoDocstring.docstringFormat": "sphinx"
}

When moving the mouse around the option, a little pencil appears that shows all the accepted values for the option.

Related questions

VSCode: There is no Pip installer available in the selected environment

I'm trying to run the autopep8 linter on a Python file in VSCode. I've followed the instructions here: https://code.visualstudio.com/docs/python/environments and selected my interpreter (⇧⌘P): /usr/local/bin/python I then try to format my …

Read More
Visual Studio Code - removing pylint

Simple question - but any steps on how to remove pylint from a Windows 10 machine with Python 3.5.2 installed. I got an old version of pylint installed that's spellchecking on old Python 2 semantics and it's bugging the heck out of me …

Read More
How to set Python language specific tab spacing in Visual Studio Code?

Using VSCode 1.9.0 with the (donjayamanne) Python 0.5.8 extension, is it possible to provide Python specific editor options? Or more generally speaking, is it possible to provide language specific tab spacing and replacement rules? For example, Python should be tab=4 spaces (replaced …

Read More