class Foo:
"""Does the thing.
Attributes:
bar (int): A short description
buzz (str): A longer description that needs to be broken up over multiple lines,
because there is additional context that I want to provide, and I don't
want to go past the 88 line length limit for whatever reason.
"""
bar: int
buzz: str
def __init__(self, bar, buzz):
self.bar = bar
self.buzz = buzz
Repro Steps
Paste code above.
Initiate signature help for __init__ by typing Foo(
Expected behavior
Current parameter's docstring is shown in markdown and there's a line separating the parameter docstring from the full docstring.
Actual behavior
Current parameter's docstring is shown in plaintext. No line separating it from the full docstring.
Apparently this is because we're using the class docstring for __init__ and the class docstring has an "Attributes" section instead of "Parameters". If you change it to "Parameters" it works as expected.
Environment data
Code Snippet
Repro Steps
__init__
by typingFoo(
Expected behavior
Current parameter's docstring is shown in markdown and there's a line separating the parameter docstring from the full docstring.
Actual behavior
Current parameter's docstring is shown in plaintext. No line separating it from the full docstring.
Apparently this is because we're using the class docstring for
__init__
and the class docstring has an "Attributes" section instead of "Parameters". If you change it to "Parameters" it works as expected.