summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2018-12-26 09:19:05 +0200
committermattip <matti.picus@gmail.com>2018-12-26 09:19:05 +0200
commitde4c4ef7e8a828331694de290582dced09c4df6f (patch)
tree8225862da233ab9e7c22a55918d045524252d4a8 /numpy
parent617dbcbe8a9a2485fe863b73f4ca3e01119b861a (diff)
downloadnumpy-de4c4ef7e8a828331694de290582dced09c4df6f.tar.gz
MAINT: improve comments
Diffstat (limited to 'numpy')
-rw-r--r--numpy/core/src/common/array_assign.c2
-rw-r--r--numpy/core/src/common/array_assign.h5
2 files changed, 4 insertions, 3 deletions
diff --git a/numpy/core/src/common/array_assign.c b/numpy/core/src/common/array_assign.c
index 8b76515ec..02a423e3a 100644
--- a/numpy/core/src/common/array_assign.c
+++ b/numpy/core/src/common/array_assign.c
@@ -129,7 +129,7 @@ raw_array_is_aligned(int ndim, npy_intp *shape,
return 1;
}
else {
- /* always return false for alignment == 0, which means unaligned */
+ /* always return false for alignment == 0, which means cannot-be-aligned */
return 0;
}
}
diff --git a/numpy/core/src/common/array_assign.h b/numpy/core/src/common/array_assign.h
index 23efd8520..69ef56bb4 100644
--- a/numpy/core/src/common/array_assign.h
+++ b/numpy/core/src/common/array_assign.h
@@ -87,9 +87,10 @@ broadcast_strides(int ndim, npy_intp *shape,
/*
* Checks whether a data pointer + set of strides refers to a raw
- * array whose elements are all aligned to a given alignment.
+ * array whose elements are all aligned to a given alignment. Returns
+ * 1 if data is aligned to alignment or 0 if not.
* alignment should be a power of two, or may be the sentinel value 0 to mean
- * unaligned, in which case false is always returned.
+ * cannot-be-aligned, in which case 0 (false) is always returned.
*/
NPY_NO_EXPORT int
raw_array_is_aligned(int ndim, npy_intp *shape,