Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenXML MS documentation #1442

Closed
farzonl opened this issue Jun 6, 2023 · 2 comments
Closed

Update OpenXML MS documentation #1442

farzonl opened this issue Jun 6, 2023 · 2 comments

Comments

@farzonl
Copy link

farzonl commented Jun 6, 2023

Describe the bug
After this commit a number of APIs were removed:
4260711
For example
GetPartsCountOfType was removed but the documentation doesn't indicated deprectated or removed in the applies to section.
https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.packaging.openxmlpartcontainer.getpartscountoftype?view=openxml-2.8.1

infact the documentation hasn't been updated since 2.8.1 and these apis lived on through 2.20.0
/~https://github.com/dotnet/Open-XML-SDK/compare/v2.20.0...v3.0.0-beta1.patch

This is particularly unpleasant because the example code in the documentation is also incorrect: https://learn.microsoft.com/en-us/office/open-xml/how-to-insert-a-comment-into-a-word-processing-document

It does appear the documentation is hosted on github. Can you please update the documentation? While I muddled through, porting my app to the latest sdk, It would be good for future users of the sdk to have a single source of truth.

@twsouthwick
Copy link
Member

This is underway! We had kind of left those docs unattended for a number of years... working to bring them back up to shape for the v3.0 release :) I'm going to close this issue in favor of this tracking issue: OfficeDev/open-xml-docs#159. Please add any comments there for additional things that you may notice that need to be updated.

@twsouthwick
Copy link
Member

FYI the api updates have been completed and the process is now known for updating for future releases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants