From de4c4ef7e8a828331694de290582dced09c4df6f Mon Sep 17 00:00:00 2001 From: mattip Date: Wed, 26 Dec 2018 09:19:05 +0200 Subject: MAINT: improve comments --- numpy/core/src/common/array_assign.c | 2 +- numpy/core/src/common/array_assign.h | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) (limited to 'numpy') 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, -- cgit v1.2.1