8000 gh-107298: Fix C API Buffer documentation by vstinner · Pull Request #108011 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-107298: Fix C API Buffer documentation #108011

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

Merged
merged 3 commits into from
Aug 16, 2023
Merged

gh-107298: Fix C API Buffer documentation #108011

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d00b3d8
gh-107298: Fix C API Buffer documentation
vstinner Aug 16, 2023
5217fa5
Fix typo; update PyExc_BufferError
vstinner Aug 16, 2023
a7de64f
Update Doc/tools/.nitignore
vstinner Aug 16, 2023
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
Prev Previous commit
Next Next commit
Fix typo; update PyExc_BufferError
  • Loading branch information
@vstinner
vstinner committed Aug 16, 2023
commit 5217fa5f258078eec797fa0f491a705564f89380
2 changes: 1 addition & 1 deletion Doc/c-api/buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ a buffer, see :c:func:`PyObject_GetBuffer`.

Constants:

.. :c:macro:: PyBUF_MAX_NDIM
.. c:macro:: PyBUF_MAX_NDIM

The maximum number of dimensions the memory represents.
Exporters MUST respect this limit, consumers of multi-dimensional
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2443,7 +2443,7 @@ Buffer Object Structures
Except for point (3), an implementation of this function MUST take these
steps:

(1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`,
(1) Check if the request can be met. If not, raise :exc:`BufferError`,
set :c:expr:`view->obj` to ``NULL`` and return ``-1``.

(2) Fill in the requested fields.
Expand Down
0