diff options
author | Eric Wieser <wieser.eric@gmail.com> | 2017-04-06 17:36:43 (GMT) |
---|---|---|
committer | Serhiy Storchaka <storchaka@gmail.com> | 2017-04-06 17:36:43 (GMT) |
commit | 9b50786bc799fee4be24c8de18a1ff55e8809483 (patch) | |
tree | 1ebedfb21d21900d7c7861b6d8501b448f7aefd9 | |
parent | d7564e538c2573105727a209f51c6db26259317b (diff) | |
download | cpython-9b50786bc799fee4be24c8de18a1ff55e8809483.zip cpython-9b50786bc799fee4be24c8de18a1ff55e8809483.tar.gz cpython-9b50786bc799fee4be24c8de18a1ff55e8809483.tar.bz2 |
Fix references within buffer protocol docs (#1016)
-rw-r--r-- | Doc/c-api/typeobj.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst index 9233278..2ebbd52 100644 --- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -1377,23 +1377,23 @@ member in the :c:type:`PyTypeObject` structure should be *NULL*. Otherwise, the Structure used to hold the function pointers which define an implementation of the buffer protocol. - The first slot is :attr:`bf_getreadbuffer`, of type :c:type:`getreadbufferproc`. + The first slot is :attr:`bf_getreadbuffer`, of type :c:type:`readbufferproc`. If this slot is *NULL*, then the object does not support reading from the internal data. This is non-sensical, so implementors should fill this in, but callers should test that the slot contains a non-*NULL* value. The next slot is :attr:`bf_getwritebuffer` having type - :c:type:`getwritebufferproc`. This slot may be *NULL* if the object does not + :c:type:`writebufferproc`. This slot may be *NULL* if the object does not allow writing into its returned buffers. - The third slot is :attr:`bf_getsegcount`, with type :c:type:`getsegcountproc`. + The third slot is :attr:`bf_getsegcount`, with type :c:type:`segcountproc`. This slot must not be *NULL* and is used to inform the caller how many segments the object contains. Simple objects such as :c:type:`PyString_Type` and :c:type:`PyBuffer_Type` objects contain a single segment. .. index:: single: PyType_HasFeature() - The last slot is :attr:`bf_getcharbuffer`, of type :c:type:`getcharbufferproc`. + The last slot is :attr:`bf_getcharbuffer`, of type :c:type:`charbufferproc`. This slot will only be present if the :const:`Py_TPFLAGS_HAVE_GETCHARBUFFER` flag is present in the :c:member:`~PyTypeObject.tp_flags` field of the object's :c:type:`PyTypeObject`. Before using this slot, the caller should test whether it |