Show description for annotations

[KTibow]

Right now, if you have an annotation on a variable, eg:

from typing import Annotated
MY_VARIABLE: Annotated[str, "Description goes here"]

You only see the typing, not the description.

I couldn't find any already existing feature requests in a quick search.

[karthiknadig]

@KTibow what do you have for python.languageServer setting?

[KTibow]

It's using "Default". I am getting linting suggestions with Pylance as the source.

[erictraut]

Annotated is not meant to be used for adding "descriptions" to a type declaration. It is intended for other domain-specific metadata. For details, refer to PEP 593.

There's nothing that prevents you from adding a string to an Annotated annotation, but this string will not (nor should it) be interpreted by general tools as a "description".

If your intent is to provide a docstring for a variable, you can do that with a variable docstring — a quoted string that appears one line below the variable.

[KTibow]

Okay, I'll use that instead. Thanks for letting me know.