doc comment forces multiline exceptions

[tx46]

1. type exception Foo({name: string, msg: string}) and run formatter
2. notice still single line
3. add doc comment:

/** foo */
exception Foo({name: string, msg: string})

and run formatter
4. notice how formatter forces multiline:

/** foo */
exception Foo({
  name: string,
  msg: string,
})

see also #7946

[zth]

Just a side note - I don't think we can call these formatter things bugs. It's a formatter behavior that's intentional. You can agree or disagree of course, and there might be good reason to change it, but it's not a bug per se.

[tx46]

Just a side note - I don't think we can call these formatter things bugs. It's a formatter behavior that's intentional. You can agree or disagree of course, and there might be good reason to change it, but it's not a bug per se.

thanks. it's unexpected behavior and there's no way for me to know if it's intentional. would you like me to not open issues on these oddities? or if you want me to, what do you want me to call them?

also if this is indeed intentional, feel free to close this. :)

[zth]

You don't need to mark them at all, we can do that as we process it. Just describe what you've found and what you expected, and we can label it appropriately from there.

[nojaf]

Is this also the case with type (records, inline in variant)?

[tx46]

Is this also the case with type (records, inline in variant)?

no, just exception

[MavenRain]

I looked into this. The cause is in print_constructor_arguments in res_printer.ml: the tuple branch wraps its arguments in a Doc.group, but the inline-record branch does not. Without its own group the record shares a group with the doc comment's hard line break, so that break propagates into the record and forces it open.

Adding the missing group makes the two branches match, and it fixes type t += /** doc */ Ext({...}) at the same time. I would like to open a small PR with the fix and printer fixtures if that is welcome.

[fhammerschmidt]

Please do!