gh-137696: Rename 'fort' parameter to 'order' in PyBuffer_* functions #137866
Conversation
|
All commit authors signed the Contributor License Agreement. |
This comment was marked as resolved.
This comment was marked as resolved.
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.
picnixz
changed the title
|
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. |
Thanks for the review, @picnixz. The functions and documentation have been updated. |
|
Let's push this forward @CarlosEduR @picnixz |
Can you review it again, @picnixz? I just merged main into this branch again to keep it up to date. |
CarlosEduR
force-pushed
the
fix-issue-137696
branch
from
41630cc to
420cd1a
Compare
… 'order' to match its declaration. Update function comment to reflect new variable name as well.
…arameter to order
…ude case when order is 'A'
CarlosEduR
force-pushed
the
fix-issue-137696
branch
from
420cd1a to
6bdf5ab
Compare
4 participants
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/