toolr.utils._docstrings

DocstringExample

Bases: Struct

Example of a docstring.

DocstringVersionChanged

Bases: Struct

Version changed entry with version as key and description as value.

Docstring

Bases: Struct

Optimized docstring representation using direct msgspec fields.

full_description property

full_description: str

Generate a full description combining all docstring sections using markdown.

parse classmethod

parse(docstring: str) -> Docstring

Parse a docstring using our rust implementation.

Source code in python/toolr/utils/_docstrings.py

@classmethod
def parse(cls, docstring: str) -> Docstring:
    """Parse a docstring using our rust implementation."""
    parser = DocstringParser()
    raw_data = parser.parse(docstring)
    return msgspec.convert(raw_data, cls)