dotnet / dotnet/Open-XML-SDK

Clean up doc comments for APIs so documentation page looks right

Open
#1,648 2 comments 0 reactions 1 assignee Claimed by @mikeebowen View on GitHub
bug: documentation
Dominant language
C#
Stars
4.6k
Forks
605
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.