docstring_parser.numpydoc.Section

class documentation

class Section: (source)

Numpydoc section parser.

Parameters
title	section title. For most sections, this is a heading like "Parameters" which appears on its own line, underlined by en-dashes ('-') on the following line.
key	meta key string. In the parsed `DocstringMeta` instance this will be the first element of the `args` attribute list.

Method	`__init__`	Undocumented
Method	`parse`	Parse `DocstringMeta` objects from the body of this section.
Instance Variable	`key`	Undocumented
Instance Variable	`title`	Undocumented
Property	`title_pattern`	Regular expression pattern matching this section's header.

def __init__(self, title: str, key: str): (source) ¶

Undocumented

def parse(self, text: str) -> T.Iterable[DocstringMeta]: (source) ¶

overridden in docstring_parser.numpydoc.DeprecationSection, docstring_parser.numpydoc.ExamplesSection, docstring_parser.numpydoc._KVSection

Parse DocstringMeta objects from the body of this section.

Parameters
text:`str`	section body text. Should be cleaned with `inspect.cleandoc` before parsing.

Returns
`T.Iterable[DocstringMeta]`	Undocumented

Undocumented

Undocumented

overridden in docstring_parser.numpydoc._SphinxSection

Regular expression pattern matching this section's header.

This pattern will match this instance's title attribute in an anonymous group.