docstring_parser.numpydoc.ParamSection

class documentation

class ParamSection(_KVSection): (source)

Constructor: ParamSection(title, key)

View In Hierarchy

Parser for numpydoc parameter sections.

E.g. any section that looks like this:
arg_name
arg_description
arg_2 : type, optional
descriptions can also span... ... multiple lines
Method _parse_item Undocumented

Inherited from _KVSection:

Method parse Parse DocstringMeta objects from the body of this section.

Inherited from Section (via _KVSection):

Method __init__ Undocumented
Instance Variable key Undocumented
Instance Variable title Undocumented
Property title_pattern Regular expression pattern matching this section's header.
def _parse_item(self, key: str, value: str) -> DocstringParam: (source) ΒΆ
overrides docstring_parser.numpydoc._KVSection._parse_item

Undocumented