Bug: parse-docstrings with janestreet profile unexpected behavior

[mbarbin]

Consider this file:
a.ml:

(* Hello.
 * This is a comment with asterix chars
 * at the beginning of every lines.
 *
 * Yay!
 *)
let () = ()

I'm trying to enable parse-docstrings=true on it.

It formats well with the default profile:

$ ocamlformat --enable-outside-detected-project --parse-docstrings a.ml
(* Hello.
 * This is a comment with asterix chars
 * at the beginning of every lines.
 *
 * Yay!
 *)
let () = ()

However note how the rest of the lines get shifted to the right when using the janestreet profile:

$ ocamlformat --enable-outside-detected-project --parse-docstrings --profile=janestreet a.ml
(* Hello.
   * This is a comment with asterix chars
   * at the beginning of every lines.
   *
   * Yay!
*)
let () = ()

Sounds like perhaps 2 bugs:

• parse-docstrings shouldn't attempt to edit this comment, because it is not a docstring comment
• the left-padding should align with what the default profile does, which respects the original intent

If you know which option from the profile is causing this, perhaps I could look into tweaking that in my configs, if this doesn't come with other downsides, as a temporary workaround? Thanks!

[Julow]

Similarly to #2642, formatting of comments with the janestreet profile is special and it doesn't support asterisk-prefixed comments. The indentation is added because each * is parsed as a word.

[mbarbin]

OK. It looks like the instances I have all look like headers (e.g. LICENSE), so I might use something like what headache produces, which does work currently.

(* Hello.                                    *)
(* This is a comment with asterisk chars     *)
(* at the beginning of every lines.          *)
(*                                           *)
(* Yay!                                      *)
let () = ()

Feel free to close the issue as "won't do" if not relevant, I'm happy with the workaround personally (up to you and/or other users). Thanks!

[mbarbin]

Oh, I hadn't seen that you fixed it already, nice! That's one less thing to think about when/if changing profile, so probably for the best. Thanks!

[Julow]

Hi! I fixed that in #2645 at the same time as the wrap-comments bug as the two had a common root cause.
Thanks for submitting the issue!