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

DOC: Add NpzFile class documentation. #24068

Merged
merged 1 commit into from
Jun 29, 2023
Merged

DOC: Add NpzFile class documentation. #24068

merged 1 commit into from
Jun 29, 2023

Conversation

liang3zy22
Copy link
Contributor

@liang3zy22 liang3zy22 commented Jun 28, 2023

This PR is to fix #6337. Don't know where to add this documentation as reference. Please give comment.

Closes #6337

Copy link
Contributor

@rossbar rossbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @liang3zy22 , +1 for adding this. Rather than adding a new section, I'd vote to add lib.npyio.NpzFile to the end of the first autosummary (i.e. after savez_compressed).

@liang3zy22
Copy link
Contributor Author

NpzFile some methods(get, items, keys, values) don't have description. Do we need to add some docstring for these methods? It seems that these methods need to be overridden.

Copy link
Contributor

@rossbar rossbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NpzFile some methods(get, items, keys, values) don't have description. Do we need to add some docstring for these methods? It seems that these methods need to be overridden.

Those are inherited from the base class - I wouldn't worry about them too much. IMO they're fine as-is (the one-line summary is descriptive enough). If you wanted to try to improve the situation, I'd recommend taking a look a the :no-inherited-members: option for autosummary; and/or the numpydoc_show_inherited_class_members configuration option (i.e. try excluding NpzFile from this listing).

Either way, if you're interested in investigating that let's do so in a follow-up PR so that we don't block this obvious improvement to the docs. Thanks @liang3zy22 !

@rossbar rossbar merged commit f050757 into numpy:main Jun 29, 2023
57 checks passed
@liang3zy22 liang3zy22 deleted the gh6337 branch June 29, 2023 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Second contribution
Development

Successfully merging this pull request may close these issues.

The f attribute of the object returned by numpy.load is not documented
2 participants