gh-137696: Rename 'fort' parameter to 'order' in PyBuffer_* functions #137866
Conversation
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
… 'order' to match its declaration. Update function comment to reflect new variable name as well.
|
All commit authors signed the Contributor License Agreement. |
This comment was marked as resolved.
This comment was marked as resolved.
nybblista
reviewed
Aug 16, 2025
Doc/c-api/buffer.rst
Outdated
|
|
||
| Copy contiguous *len* bytes from *buf* to *view*. | ||
| *fort* can be ``'C'`` or ``'F'`` (for C-style or Fortran-style ordering). | ||
| *order* can be ``'C'`` or ``'F'`` (for C-style or Fortran-style ordering). |
There was a problem hiding this comment.
The comment of the PyBuffer_FromContiguous explained the case when the order is A. So, I think we should add a line or two to explain that case in the documentation as well.
There was a problem hiding this comment.
Documentation updated to include this case.
|
Please see #137696 (comment) and change the functions (declarations and definitions) as well as the documentation so that all of them use 'order' instead of a mix of all. In addition, please sign the CLA. |
…arameter to order
…ude case when order is 'A'
Thanks for the review, @picnixz. The functions and documentation have been updated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the
PyBuffer_FromContiguousfunction by renaming thefortparameter toorderfor clarity. The function's declaration in the header already usesorder; this change updates all references in the implementation and documentation to match.It also updates the declaration of the
PyBuffer_IsContiguousfunction in the header by renamingforttoorder. Its documentation and definition were already usingorderas the parameter name.ordernaming forPyBuffer_*functions #137696📚 Documentation preview 📚: https://cpython-previews--137866.org.readthedocs.build/