Improved or cusomizable Docstring Format

[tbrodbeck]

It is great that VS Code support automatic docstring generation in Python. I am just missing one Docstring Format that is optimal for my needs. It would also be helpful to fully customize and create your own Docstring format to choose from.

Format right now (using Google format)

  """[summary]

  Args:
      lmNameOrID (str): [description]
      corpora (list, optional): [description]. Defaults to [].
      grammars (list, optional): [description]. Defaults to [].
      wordsFiles (list, optional): [description]. Defaults to [].
      corporaPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/corpus/'.
      grammarsPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/grammar/'.
      wordsPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/custom_words/'.
      retrain (bool, optional): [description]. Defaults to False.
  """

Improved format

  """[summary]
  Args:
      lmNameOrID (str): [description]
      corpora (list, optional): [description]. Defaults to [].
      grammars (list, optional): [description]. Defaults to [].
      wordsFiles (list, optional): [description]. Defaults to [].
      corporaPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/corpus/'.
      grammarsPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/grammar/'.
      wordsPath (str, optional): [description]. Defaults to 'agent-assist-speech-to-text/in/custom_words/'.
      retrain (bool, optional): [description]. Defaults to False."""

This is still a viable Google Format docstring I prefer because it simply takes less space than the original Google format. It would be great if this would be supported by VS Code in some way.

[brettcannon]

We actually don't support generating docstrings. Perhaps you're thinking of another extension?

Regardless, I'm going to close this as a duplicate of microsoft/pylance-release#5279 which you can 👍 to show your support for that idea.

[tbrodbeck]

As I understand microsoft/pylance-release#5279 this is not about having customizable docstrings.
I think it is about auto generating docsting support and that is already working in my version of VS Code.

[brettcannon]

@tbrodbeck to us they are the same thing (and as I said, we don't generate docstrings in our extension, so I'm not sure where you're getting those from but it isn't us).