Function _parse_docstring_sections

hvplot/util.py:950–976

Used to parse the docstring that contains all the plot options.

(docstring: str)

def _parse_docstring_sections(docstring: str) -> dict[str, str]:
    """Used to parse the docstring that contains all the plot options."""
    docstring = docstring.strip()
    if docstring.startswith('"""') and docstring.endswith('"""'):
        docstring = docstring[3:-3].strip()

    lines = docstring.splitlines()
    section_headers = []

    for i, line in enumerate(lines):
        if (
            i < len(lines) - 1
            and set(lines[i + 1].strip()) == {'-'}
            and len(lines[i + 1].strip()) >= 3
        ):
            section_headers.append((i, line.strip()))

    sections = {}
    for i, section_header in enumerate(section_headers):
        start_line = section_headers[i][0]
        if i == len(section_headers) - 1:
            section_text = '\n'.join(lines[start_line:])
        else:
            end_line = section_headers[i + 1][0]
            section_text = '\n'.join(lines[start_line:end_line])
        sections[section_header[1]] = section_text.strip()
    return sections


_METHOD_DOCS = {}