Line breaks in documentation comments aren't formatted when displayed about rescript-vscode

[amiralies]

The point here is that interpolated strings have different behavour when escpaing special characters

let foo = `foo
bar`

is being parsed into "foo\\nbar". this is not suppored by ocaml doc parser. @IwanKaramazow can confirm if this is expected behaviour.

it should be ok using normal strings "".

Note: note that ocamldoc is not supported as first class in rescript, in future this will improve.

[zth]

But using normal strings won't work with unicode?

[amiralies]

Hmm, that's a specific use case, maybe @IwanKaramazow can help.
But again, ocaml doc is not supported properly in rescript and there's a plan for a friendly first-class in-code doc support for rescript.

[zth]

Ok, so to summarize so far:

• Multiline doc strings will work fine with regular strings ""
• Multiline interpolation won't
• @ocaml.doc isn't necessarily supported (although it does seem to work). At some point there might be a first class code doc support in ReScript itself

So, as of now it'll work as long as you don't need unicode in your doc strings. Does that sound about right?

[zth]

I'm closing this since I got my question answered.