Clean up doc comments for APIs so documentation page looks right - Githubissues

dotnet / Open-XML-SDK

Open XML SDK by Microsoft

https://www.nuget.org/packages/DocumentFormat.OpenXml/

MIT License

3.99k stars 545 forks source link

Clean up doc comments for APIs so documentation page looks right #1648

Open twsouthwick opened 8 months ago

twsouthwick commented 8 months ago

This issue is to track updates we should do to the doc comments so that results look like

[ ] Part types should not list the types they're mapping, but rather have that as part of the doc for the member itself. For example see https://review.learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.packaging.imageparttype?view=openxml-3.0.1&branch=smoke-test
[x] PresetTextWrap should be PresetTextWarp in https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.drawing.presettextwrap?view=openxml-2.8.1

AlfredHellstern commented 7 months ago

for #2: link to corrected topic is https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.drawing.presettextwarp?view=openxml-3.0.1&viewFallbackFrom=openxml-2.8.1