Smart

Handsdown API Index / Handsdown / Processors / Smart

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

SmartDocstringProcessor

Show source in smart.py:15

Docstring processor that selects a DocstringProcessor based on a docstring content.

Signature

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

See also

• BaseDocstringProcessor

SmartDocstringProcessor().build_sections

Show source in smart.py:28

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