Base Docstring Processor

Handsdown API Index / Handsdown / Processors / Base Docstring Processor

Auto-generated documentation for handsdown.processors.base module.

BaseDocstringProcessor

Show source in base.py:28

Base docstring processor. All docstring processors are based on top of it.

Attributes

• line_re_map - Mapping of line regexp to format string for it
• section_name_map - Mapping of Section search key to Section title
• replace_map - Mapping of string to replace to replacer

Signature

class BaseDocstringProcessor:
    def __init__(self) -> None:
        ...

BaseDocstringProcessor().build_sections

Show source in base.py:66

Parse docstring and split it to sections with arrays of strings.

Arguments

• content - Object docstring.

Returns

A dictionary where key is a section name and value is a list of string sof this section.

Signature

def build_sections(self, content: str) -> SectionMap:
    ...

See also

• SectionMap