ocamlformat icon indicating copy to clipboard operation
ocamlformat copied to clipboard

Improve error message for fragile or changed docstrings

Open jberdine opened this issue 7 years ago • 2 comments

For cases where ocamlformat cannot reformat docstrings, the error message should be informative to and actionable by the user.

jberdine avatar Nov 16 '18 16:11 jberdine

So the message added in #481 is not informative enough?

gpetiot avatar Apr 11 '19 05:04 gpetiot

The current message is not bad, but it does not indicate what the problem is specifically, just that something in the docstring isn't right. It would be better to more precisely indicate exactly where in the docstring the problem is located.

jberdine avatar Apr 13 '19 20:04 jberdine