The code base I'm working has a convention on to how to document class attributes.
Here's how it looks:
@dataclass
class SessionMetadata:
"""Metadata of a Session
Attributes:
created_at: Date of creation, in POSIX timestamp format.
usage_count: The number of times the session was applied to the payload.
"""
created_at: int
usage_count: int
However, I do not get shown my documentation when hovering over the property:
In the past, I was using another notation:
@dataclass
class SessionMetadata:
created_at: int
"""
Date of creation, in POSIX timestamp format.
"""
usage_count: int
"""
The number of times the session was applied to the payload.
"""
And I did get my documentation on hover:
I tried updating Pylance. It didn't help.
I tried looking into GitHub issues, but I couldn't really find anything that mentions the format I'm using.
Has someone a similar docstring convention that shows documentation on hover, with VSCode?
