markdown_refdocs/parsers

parse_google_docstring()

parses a google-style docsting into a dictionary of the various sections

def parse_google_docstring(
    docstring: Optional[str], hide_undoc: bool = True, function_name=''
) -> ParsedDocstring:

Args

• docstring (Optional[str]): the docstring to parse
• hide_undoc (bool): if True, undocumented arguments will be marked as hidden
• function_name: name of the function the docstring is for (only used in debugging)

Returns

• ParsedDocstring