fern icon indicating copy to clipboard operation
fern copied to clipboard

feat(csharp): XML encode contents of <summary> and <example><code> code comments

Open Swimburger opened this issue 1 year ago • 2 comments

When < and > are used inside of summary or code example XML docs, the XML doc is invalid. This PR HTML encodes the contents before putting it in the XML doc.

This will also XML encode other characters which aren't really necessary, like ", but IDEs continue to show the XML docs correctly.

Swimburger avatar Oct 01 '24 16:10 Swimburger

🌿 Preview your docs: https://fern-preview-2d284a09-8835-4272-bb69-86c86a271d9e.docs.buildwithfern.com/learn

github-actions[bot] avatar Oct 01 '24 17:10 github-actions[bot]

This part of the description is no longer accurate, correct?

This will also XML encode other characters which aren't really necessary, like ", but IDEs continue to show the XML docs correctly.

dcb6 avatar Oct 03 '24 20:10 dcb6

This part of the description is no longer accurate, correct?

This will also XML encode other characters which aren't really necessary, like ", but IDEs continue to show the XML docs correctly.

Correct!

Swimburger avatar Oct 04 '24 22:10 Swimburger