diff options
| author | Julian Taylor <juliantaylor108@gmail.com> | 2017-07-11 12:31:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-11 12:31:00 +0200 |
| commit | 8294859c4ae8c06608ec89a771a898c41b604dfd (patch) | |
| tree | 94dcb9f4b783ba546c53ffb596ce6d73c8c9c60f /doc/source/reference/c-api.array.rst | |
| parent | 110825244a1555f594b585c72568084f1863ca1b (diff) | |
| parent | 3f3317a44512d2138071ac3e5e540bae86535df0 (diff) | |
| download | numpy-8294859c4ae8c06608ec89a771a898c41b604dfd.tar.gz | |
Merge pull request #9399 from jaimefrio/intp_converter_doc
DOC: document how to free memory from PyArray_IntpConverter.
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index b00919fae..ad0be871a 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -2887,10 +2887,10 @@ to. to a C-array of :c:type:`npy_intp`. The Python object could also be a single number. The *seq* variable is a pointer to a structure with members ptr and len. On successful return, *seq* ->ptr contains a - pointer to memory that must be freed to avoid a memory leak. The - restriction on memory size allows this converter to be - conveniently used for sequences intended to be interpreted as - array shapes. + pointer to memory that must be freed, by calling :c:func:`PyDimMem_FREE`, + to avoid a memory leak. The restriction on memory size allows this + converter to be conveniently used for sequences intended to be + interpreted as array shapes. .. c:function:: int PyArray_BufferConverter(PyObject* obj, PyArray_Chunk* buf) |