search

ocaml / odoc

Documentation compiler for OCaml and Reason
Other
321 stars 90 forks source link

Error reporting / warnings are inconsistent and don't make sense #786

Open jonludlam opened 2 years ago

jonludlam commented 2 years ago

See e.g. https://github.com/ocaml/odoc/pull/784 for some confusion caused.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. The main purpose of this is to keep the issue tracker focused to what is actively being worked on, so that the amount and variety of open yet inactive issues does not overwhelm contributors.

An issue closed as stale is not rejected — further discussion is welcome in its closed state, and it can be resurrected at any time. odoc maintainers regularly check issues that were closed as stale in the past, to see if the time is right to reopen and work on them again. PRs addressing issues closed as stale are as welcome as PRs for open issues. They will be given the same review attention, and any other help.

mbarbin commented 9 months ago

https://github.com/ocaml/odoc/pull/784#discussion_r756772278

+1 about this. I think it would be a great user improvement to hide the warnings that are not actionable (internals) from the user, and especially these that print Warning: when in warn-error mode.