Fix incorrect and missing docstrings in pybuffer.h#152118
Open
AivazianArtur wants to merge 2 commits into
Open
Fix incorrect and missing docstrings in pybuffer.h#152118AivazianArtur wants to merge 2 commits into
AivazianArtur wants to merge 2 commits into
Conversation
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
All commit authors signed the Contributor License Agreement. |
Author
|
Looks like something like typo, so no need for an issue |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
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
1 participant
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.
First of all this is a fix of docstring of PyBuffer_IsContiguous declaration - there were something about copying, not checking;
Then there are docstrings for other contiguous-related functions - PyBuffer_ToContiguous and PyBuffer_FromContiguous. I copypasted it straight from the descriptions of those methods in buffers.rst, but adapted a bit for docstring format and for them to be consistent with other docstrings in these file