Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
DocumentationExtraction bug for java docstyle. #4029
DocumentationExtraction works good when java docstyle as given below is used.
But if we remove that one space from that mid marker and end marker as follows
DocumentationExtraction doesn't return anything. We need to throw a nice warning message for the above case.
Right now the documentation extraction functions can only return an identified docstring or None. To deal with this issue, we should add an error state as a third possibility, when a start marker is found but the others aren't. I'm not sure if raising an Exception or returning some kind of error object is better.