Skip to content

FunctionDocstring

Source code in src/library_analyzer/processing/api/model/_docstring.py 
24
25
26
27
28
29
30
31
32
33
34
@dataclass(frozen=True)
class FunctionDocstring:
    description: str = ""
    full_docstring: str = ""

    @staticmethod
    def from_dict(d: dict[str, Any]) -> FunctionDocstring:
        return FunctionDocstring(**d)

    def to_dict(self) -> dict[str, Any]:
        return dataclasses.asdict(self)

description: str = '' class-attribute instance-attribute

full_docstring: str = '' class-attribute instance-attribute

__init__(description='', full_docstring='')

from_dict(d) staticmethod

Source code in src/library_analyzer/processing/api/model/_docstring.py 
29
30
31
@staticmethod
def from_dict(d: dict[str, Any]) -> FunctionDocstring:
    return FunctionDocstring(**d)

to_dict()

Source code in src/library_analyzer/processing/api/model/_docstring.py 
33
34
def to_dict(self) -> dict[str, Any]:
    return dataclasses.asdict(self)