Skip to content

Fix incorrect and missing docstrings in pybuffer.h #152118

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.

Sign up for GitHub

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

Open
AivazianArtur wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −3
Open

Fix incorrect and missing docstrings in pybuffer.h #152118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
041a6dc
Fix incorrect and missing docstrings in pybuffer.h
AivazianArtur Jun 24, 2026
790c783
Merge branch 'main' into pybuffer_contiguous_methods_descr
AivazianArtur Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions Include/pybuffer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,17 @@ PyAPI_FUNC(void *) PyBuffer_GetPointer(const Py_buffer *view, const Py_ssize_t *
struct-style description. */
PyAPI_FUNC(Py_ssize_t) PyBuffer_SizeFromFormat(const char *format);

/* Implementation in memoryobject.c */
/* Copy 'len' bytes from 'src' to its contiguous representation in 'buf'.

Returns 0 on success and -1 on error; fails if len != src->len.
Implementation in memoryobject.c */
PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, const Py_buffer *view,
Py_ssize_t len, char order);

/* Copy contiguous 'len' bytes from 'buf' to 'view'.
'fort' can be 'C' or 'F' (for C-style or Fortran-style ordering).

Returns 0 on success and -1 on error. */
PyAPI_FUNC(int) PyBuffer_FromContiguous(const Py_buffer *view, const void *buf,
Py_ssize_t len, char order);

Expand All @@ -76,10 +83,14 @@ PyAPI_FUNC(int) PyBuffer_FromContiguous(const Py_buffer *view, const void *buf,
in whatever way is more efficient. */
PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);

/* Copy the data from the src buffer to the buffer of destination. */
/* Check if the memory defined by the 'view' is contiguous.
Possible contiguous style defined in 'order' are `C`, `F` or `A`.
That means C-style, Fortran-style or Any of them, respectively.

Returns 1 on success and 0 otherwise, without raising an error. */
PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char order);

/*Fill the strides array with byte-strides of a contiguous
/* Fill the strides array with byte-strides of a contiguous
(Fortran-style if order is 'F' or C-style otherwise)
array of the given shape with the given number of bytes
per element. */
Expand Down
Loading