DOC: core: Improve some documentation of internal functions

msimpson253 · Jul 11, 2011 · 2ad4a71 · 2ad4a71
1 parent 92ede9c
commit 2ad4a71
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/numpy/core/src/multiarray/lowlevel_strided_loops.c.src b/numpy/core/src/multiarray/lowlevel_strided_loops.c.src
@@ -921,6 +921,7 @@ PyArray_GetStridedNumericCastFn(int aligned, npy_intp src_stride,
 
 /****************** PRIMITIVE FLAT TO/FROM NDIM FUNCTIONS ******************/
 
+/* See documentation of arguments in lowlevel_strided_loops.h */
 NPY_NO_EXPORT npy_intp
 PyArray_TransferNDimToStrided(npy_intp ndim,
                 char *dst, npy_intp dst_stride,
@@ -1039,6 +1040,7 @@ PyArray_TransferNDimToStrided(npy_intp ndim,
     }
 }
 
+/* See documentation of arguments in lowlevel_strided_loops.h */
 NPY_NO_EXPORT npy_intp
 PyArray_TransferStridedToNDim(npy_intp ndim,
                 char *dst, npy_intp *dst_strides, npy_intp dst_strides_inc,
@@ -1157,6 +1159,7 @@ PyArray_TransferStridedToNDim(npy_intp ndim,
     }
 }
 
+/* See documentation of arguments in lowlevel_strided_loops.h */
 NPY_NO_EXPORT npy_intp
 PyArray_TransferMaskedStridedToNDim(npy_intp ndim,
                 char *dst, npy_intp *dst_strides, npy_intp dst_strides_inc,

diff --git a/numpy/core/src/private/lowlevel_strided_loops.h b/numpy/core/src/private/lowlevel_strided_loops.h
@@ -228,6 +228,7 @@ PyArray_CastRawArrays(npy_intp count,
                       npy_intp src_stride, npy_intp dst_stride,
                       PyArray_Descr *src_dtype, PyArray_Descr *dst_dtype,
                       int move_references);
+
 /*
  * These two functions copy or convert the data of an n-dimensional array
  * to/from a 1-dimensional strided buffer.  These functions will only call
@@ -241,9 +242,9 @@ PyArray_CastRawArrays(npy_intp count,
  *
  * ndim:
  *      The number of dimensions of the n-dimensional array.
- * dst/src:
- *      The destination or src starting pointer.
- * dst_stride/src_stride:
+ * dst/src/mask:
+ *      The destination, source or mask starting pointer.
+ * dst_stride/src_stride/mask_stride:
  *      The stride of the 1-dimensional strided buffer
  * dst_strides/src_strides:
  *      The strides of the n-dimensional array.
@@ -268,8 +269,7 @@ PyArray_CastRawArrays(npy_intp count,
  *      The strided transfer function.
  * transferdata:
  *      An auxiliary data pointer passed to the strided transfer function.
- *      If a non-NULL value is returned, it must be deallocated with the
- *      function PyArray_FreeStridedTransferData.
+ *      This follows the conventions of NpyAuxData objects.
  */
 NPY_NO_EXPORT npy_intp
 PyArray_TransferNDimToStrided(npy_intp ndim,