Does pylance support displaying a url with a label?

[shadycuz]

I'm not sure if label is the correct terminology. But you know when you have some word that is backed by a URL.

pylance seems to support URLs but not the label kind, I have tried different variations including google and reST style links.

I opened a discussion because I wasn't sure if I was just doing it wrong or maybe its the responsibility of the python extension and not the language server.

Docstring:

"""AWS Intrinsic functions.

This module contains the logic to render both AWS `Intrinsic function`_
and https://google.com

by the `Google Python Style Guide`_.
.. _Intrinsic function:
   https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
.. _Google Python Style Guide:
   http://google.github.io/styleguide/pyguide.html
"""

[jakebailey]

Can you file an issue for this? This'd be an enhancement.

Our docstring parser is very loose and tries to understand most formats; this is a ReST specific format that we don't handle.

[jakebailey]

https://github.com/microsoft/pylance-release/issues/new/choose and just fill out the feature request template.

[gvanrossum]

is there a format you do handle? Other than just pasting in a URL I could not get one with a label to work.

Perhaps the Markdown format works? That would be [label](url).

[shadycuz]

Perhaps the Markdown format works? That would be [label](url).

Even after reading the source code of pyright and seeing that the extension processed Markdown, I still didn't think of this 😊.

Didn't work for me though.

[jakebailey]

No, I'm afraid none of these methods will work; the docstring converter is only a loose converter, and doesn't actually parse or understand any given docstring format. It will treat this as regular text depending on the context. To really support formats, we will need to do something else, but that's trickier to manage when everyone has their own formats.

[shadycuz]

This seems like a good use case for hooks? I've never developed a plugin for vscode before so I'm not sure what it is capable of but what if pylance DID NOT implement this feature because of all the different formats but instead offered to allow other plugins to render the docstrings for pylance. That would allow someone to develop a plugin for reST that implements all those features. This leaves pylance to focus only whats in the PEP specification for docstrings.