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

SpreadsheetDocument Class documentation contains non-existent Close method #1683

Open
james-d-hasselman opened this issue Mar 1, 2024 · 3 comments

Comments

@james-d-hasselman
Copy link

Describe the bug
The documentation for the SpreadsheetDocument Class contains a Close method from 2.X which was removed in 3.X. Documentation for the final version of 2.X states that the method will be removed in later releases. Both the 3.0.0 and 3.0.1 documentation need to be updated.

To Reproduce
Go here and search under methods for Close.

Observed behavior
I get the build error 'SpreadsheetDocument' does not contain a definition for Close

Expected behavior
The documentation should be updated to reflect the removal of the Close method in release 3.0.0.

Desktop (please complete the following information):

  • DocumentFormat.OpenXml Version: 3.0.1
@thirstyape
Copy link

Agreed, as this issue was merged the documentation should reflect that.

@twsouthwick
Copy link
Member

Both the 3.0.0 and 3.0.1 documentation need to be updated.

What are envisioning here? The API is not listed as available for v3+ and a large banner is on 2.20.0 saying it's obsolete: https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.packaging.openxmlpackage.close

@thirstyape
Copy link

I think this may apply to classes that inherit OpenXmlPackage such as SpreadsheetDocument. You can see here that the documentation in the 3.0.1 version does not note Obsolete as it does in the base class (at least on the summary page, clicking further in does in fact have the correct details).

I would think either having the Obsolete note on the summary page or removing that method from the versions it does not apply to would be ideal.

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

3 participants