Question: does it raise for invalid docstrings?

[julien-c]

Hi,

Thanks for your library it looks awesome. Does the parser raise an exception if the docstring's syntax is not correct Google-style syntax?

(Trying to build a simple docstring CI validation in my repo)

Thanks!

[Peter200lx]

Looks like this issue is hitting timothycrosley/pdocs#19 as well, ideally a misparse should be caught and raised as a docstring_parser.ParseError instead of the ValueError getting propagated up to the calling tool

[rr-]

Sorry for the late reply. It's supposed to raise a ParseError, if it does not, it's an error and we need specific input to debug it.

[Peter200lx]

Here is a poorly formatted doc string that would hit this:

def test(param: str) -> str:
    """This is a test

    Args:
        param - poorly formatted
    """
    return param

[rr-]

Thanks @Peter200lx , I can confirm that 0.8 still had a problem with this kind of input and the package now raises a ParseError as of 0.8.1.