ocamlformat
ocamlformat copied to clipboard
Bug: comment changed /doc-comment dropped (mli)
Describe the bug
ocamlformat: Cannot process "lib/miou_vector.mli".
Please report this bug at https://github.com/ocaml-ppx/ocamlformat/issues.
BUG: comment changed.
File "_none_", line 1:
Error: doc-comment (** similar to [top], but with an option instead of an exception *) dropped.
How to Reproduce Steps to reproduce the behavior:
- What is the formatted file? Please try to minimize the code snippet.
The comment in question is in the file
miou_vector.mli. e.g. at revision 01b75212e595d154a0f24387e0fdde8cf86254f2 permalink
To note, this file has a directive at the top of the file to disable ocamlformat:
[@@@ocamlformat "disable"]
...
val top_opt: 'a t -> 'a option
(** similar to [top], but with an option instead of an exception *)
- What are the selected options?
As specified by the project in .ocamlformat file.
Additional notes
- This may be a dup of #2585 , however this is in a mli file. Tracking as new issue, you can decide whether to close this one.
- Listing the file in a local
.ocamlformat-ignorefile resolve the issue, as an immediate work around. - Tried both with ocamlformat
0.26.2and0.27.0- both display the same issue.
Thanks for this extremely well written issue :) This might be related to https://github.com/ocaml-ppx/ocamlformat/issues/2587
Hey @Julow very nice hearing from you! Thank you for looking into this issue.
Regarding its phrasing, credit goes back to the team that created the issue template, as I naively followed it as if I was filling out a form. Very pleasing experience! Thanks for this.