FSharp.Formatting icon indicating copy to clipboard operation
FSharp.Formatting copied to clipboard

New lines in API reference docs are not included

Open kMutagene opened this issue 3 years ago • 1 comments

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

kMutagene avatar Jan 20 '22 08:01 kMutagene

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

rdipardo avatar Jan 24 '22 11:01 rdipardo