Skip to content

ClassDocumentation

Source code in library_analyzer/processing/api/model/_documentation.py 
 7
 8
 9
10
11
12
13
14
15
16
17
@dataclass
class ClassDocumentation:
    description: str = ""
    full_docstring: str = ""

    @staticmethod
    def from_dict(d: dict) -> ClassDocumentation:
        return ClassDocumentation(**d)

    def to_dict(self) -> dict:
        return dataclasses.asdict(self)

description: str = '' class-attribute

full_docstring: str = '' class-attribute

from_dict(d) staticmethod

Source code in library_analyzer/processing/api/model/_documentation.py 
12
13
14
@staticmethod
def from_dict(d: dict) -> ClassDocumentation:
    return ClassDocumentation(**d)

to_dict()

Source code in library_analyzer/processing/api/model/_documentation.py 
16
17
def to_dict(self) -> dict:
    return dataclasses.asdict(self)