Skip to content

get_full_docstring

Returns the full docstring of the given declaration or an empty string if no docstring is available. Indentation is cleaned up.

Source code in library_analyzer/processing/api/documentation_parsing/_get_full_docstring.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
def get_full_docstring(
    declaration: Union[astroid.ClassDef, astroid.FunctionDef]
) -> str:
    """
    Returns the full docstring of the given declaration or an empty string if no docstring is available. Indentation is
    cleaned up.
    """

    doc_node = declaration.doc_node
    if doc_node is None:
        return ""
    return inspect.cleandoc(doc_node.value)