Example #1
0
def docstringify(docstring):
    for docstring_type in [GoogleDocstring]:
        instance = docstring_type(docstring)
        if instance.is_valid():
            return instance

    return _check_docs_utils.Docstring(docstring)
Example #2
0
def docstringify(docstring):
    """Converts a docstring in its str form to its Docstring object
    as defined in the pylint library.

    Args:
        docstring: str. Docstring for a particular class or function.

    Returns:
        Docstring. Pylint Docstring class instance representing
        a node's docstring.
    """
    for docstring_type in [GoogleDocstring]:
        instance = docstring_type(docstring)
        if instance.is_valid():
            return instance

    return _check_docs_utils.Docstring(docstring)