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

New lines in API reference docs are not included #736

Open kMutagene opened 2 years ago

kMutagene commented 2 years ago

New lines seem to be omitted from XML docs in the created API documentation. See below screenshot for a comparison of the input (left) and the generated output (right)

This makes large structured docs hard to read.

image

rdipardo commented 2 years ago

Quick fix: assuming none of the docs contain explicit XML markup (<summary>...</summary>, etc.), just use the --mdcomments command line option to render everything as Markdown:

mdcomments_example