Commit 774c8a39 authored by Andrew Svetlov's avatar Andrew Svetlov

fix docs for c-api memory functions

parent 8afcec41
...@@ -98,7 +98,7 @@ memory from the Python heap: ...@@ -98,7 +98,7 @@ memory from the Python heap:
Allocates *n* bytes and returns a pointer of type :c:type:`void\*` to the Allocates *n* bytes and returns a pointer of type :c:type:`void\*` to the
allocated memory, or *NULL* if the request fails. Requesting zero bytes returns allocated memory, or *NULL* if the request fails. Requesting zero bytes returns
a distinct non-*NULL* pointer if possible, as if :c:func:`PyMem_Malloc(1)` had a distinct non-*NULL* pointer if possible, as if ``PyMem_Malloc(1)`` had
been called instead. The memory will not have been initialized in any way. been called instead. The memory will not have been initialized in any way.
...@@ -106,7 +106,7 @@ memory from the Python heap: ...@@ -106,7 +106,7 @@ memory from the Python heap:
Resizes the memory block pointed to by *p* to *n* bytes. The contents will be Resizes the memory block pointed to by *p* to *n* bytes. The contents will be
unchanged to the minimum of the old and the new sizes. If *p* is *NULL*, the unchanged to the minimum of the old and the new sizes. If *p* is *NULL*, the
call is equivalent to :c:func:`PyMem_Malloc(n)`; else if *n* is equal to zero, call is equivalent to ``PyMem_Malloc(n)``; else if *n* is equal to zero,
the memory block is resized but is not freed, and the returned pointer is the memory block is resized but is not freed, and the returned pointer is
non-*NULL*. Unless *p* is *NULL*, it must have been returned by a previous call non-*NULL*. Unless *p* is *NULL*, it must have been returned by a previous call
to :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. If the request fails, to :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. If the request fails,
...@@ -118,7 +118,7 @@ memory from the Python heap: ...@@ -118,7 +118,7 @@ memory from the Python heap:
Frees the memory block pointed to by *p*, which must have been returned by a Frees the memory block pointed to by *p*, which must have been returned by a
previous call to :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. Otherwise, or previous call to :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. Otherwise, or
if :c:func:`PyMem_Free(p)` has been called before, undefined behavior occurs. If if ``PyMem_Free(p)`` has been called before, undefined behavior occurs. If
*p* is *NULL*, no operation is performed. *p* is *NULL*, no operation is performed.
The following type-oriented macros are provided for convenience. Note that The following type-oriented macros are provided for convenience. Note that
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment