search

fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
464 stars 155 forks source link

When using XML docs, backtick characters break the output #748

Open seanamos opened 2 years ago

seanamos commented 2 years ago

When using XML docs (<summary>, <cref> etc.), if they contain a ` character, the output gets broken.

See: https://fsprojects.github.io/FSharp.Formatting/apidocs.html Look at referringFunction2 and Foo.Bar

seanamos commented 1 year ago

This has been open for quite some time, so I thought I would add some examples.

These are from: https://fsprojects.github.io/FSharp.Formatting/apidocs.html

image image