docstring_parser.epydoc

module documentation

(source)

Epyoc-style docstring parsing.

Function	`compose`	Render a parsed docstring into docstring text.
Function	`parse`	Parse the epydoc-style docstring into its components.
Function	`_clean_str`	Undocumented

def compose(docstring: Docstring, rendering_style: RenderingStyle = RenderingStyle.COMPACT, indent: str = ' ') -> str: (source) ¶

Render a parsed docstring into docstring text.

Parameters
docstring:`Docstring`	parsed docstring representation
rendering_style:`RenderingStyle`	the style to render docstrings
indent:`str`	the characters used as indentation in the docstring string

Returns
`str`	docstring text

def parse(text: str | None) -> Docstring: (source) ¶

Parse the epydoc-style docstring into its components.

Returns
`Docstring`	parsed docstring

def _clean_str(string: str) -> str | None: (source) ¶

Undocumented