Docstring for function with decorators (@property) not displayed in IntelliSense

[fsktom]

Environment data

• VS Code version: 1.51.1
• Extension version: 2020.11.371526539
• OS and version: Windows 10 20H2
• Python version: 3.9.0

Expected behaviour

IntelliSense should show the docstring for a @property function when hovering over it, but doesn't.
It should display something like this:

Actual behaviour

It displays just its type.

Steps to reproduce:

class MyClass(object):
    """
    MyClass Docstring
    """

    def __init__(self, length):
        self._length = length

    @property
    def length(self):
        """
        This should be displayed, but isn't
        """
        return self._length

    @length.setter
    def length(self, value):
        if value < 0:
            raise ValueError("The length cannot be negative!")
        else:
            self._length = value


one = MyClass(3)
one.length = -2

1. Put this code into VS Code
2. Hover over length in one.length in the last line
3. See that it displays length: int instead of This should be displayed, but isn't

Maybe I'm just doing it wrong, if so please enlighten me. (I'm learning Python and it's my first time using @property)

[luabud]

Hey there, it looks like you're using Pylance, so I'm transferring it to pylance's repo. If that's not it, please do try it out and see if that fixes your issue!

[erictraut]

It doesn't appear that you're using Pylance. Perhaps you have MPLS or Jedi configured instead?

Here's what Pylance displays in this case:

[fsktom]

Seems like @erictraut was right: Jedi was selected as the Python language server

I installed Pylance as @luabud suggested and now it displays properly like in the screenshot above. I guess I'll use Pylance from now on.

Though I'm not sure if that's the optimal outcome. But thanks for helping me :D

[fsktom]

I just noticed one thing (relating to Pylance). I don't know if that's desired behavior or not, but in the autocompletion tooltip the docstring for the property is not displayed, only for the class.

[jakebailey]

Does it work if you complete it and hover over length, i.e. does it only break when it's in the completion tooltip?

[fsktom]

Indeed. That's the case. I could make a video/gif showcasing that if you need it

[savannahostrowski]

This will be fixed in the next version of Pylance.

@bschnurr

[fsktom]

Thank you! :D

[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