DOC: clarify that read_array_header requires prior read_magic call#31231
Open
agp19d wants to merge 1 commit intonumpy:mainfrom
Open
DOC: clarify that read_array_header requires prior read_magic call#31231agp19d wants to merge 1 commit intonumpy:mainfrom
agp19d wants to merge 1 commit intonumpy:mainfrom
Conversation
Update docstrings for read_array_header_1_0 and read_array_header_2_0 to note that fp must be positioned after the magic string and version bytes, e.g. by calling read_magic first. Closes numpy#29159
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR summary
Update the docstrings for
read_array_header_1_0andread_array_header_2_0to note that the file object must be positionedafter the magic string and version bytes, e.g. by calling
read_magicfirst.
Closes #29159
AI Disclosure
No AI tools used