Pylance-release: Support for different docstring formats

[gijswobben]

I'm using the docstring notation format from Google (https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings) and it would be nice if PyLance would be able to read this properly. Currently, my args and returns are just concatenated into a single string..

[Destaq]

Potential duplicate of #41? Perhaps you'd like to add your comment there instead so that all of the issues/comments concerning docstring printouts are in one place?

[gijswobben]

Potential duplicate of #41? Perhaps you'd like to add your comment there instead so that all of the issues/comments concerning docstring printouts are in one place?

Not really... I'm not asking for markdown, but for docstring parsing with different formats (like Google style, numpy style, etc.)

[erictraut]

This is related to this issue in the pyright repo: https://github.com/microsoft/pyright/issues/721

[go2sh]

It would be nice to parse those formats and display the information e.g. when you hover a named function parameter.

[varunagrawal]

Note that while it is related to the issue in pyright, that issue has been closed since this issue is the focal point.

I would really like to see this feature implemented sooner since it makes transitioning to VSCode for Python a lot easier.

[jakebailey]

The next release includes expanded support for things like parameter lists and other indented regions in docstrings.

[jakebailey]

Given the original issue was really focused on these indented regions, I think I'm going to mark this as fixed in today's release. We intend for these docs to look good, and can consider bugs with the new handling in new issues.

[jakebailey]

This issue has been fixed in version 2021.2.0, which we've just released. You can find the changelog here: https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md#202120-3-february-2021