summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorMark Wiebe <mwwiebe@gmail.com>2012-05-09 13:45:45 -0500
committerCharles Harris <charlesr.harris@gmail.com>2012-05-10 00:47:30 -0600
commit2c4f794b9ed9618cb8187af98eb59b73bb380e2e (patch)
tree1036ca913bcbe565f203d8d47ed1bb85365bff6f /numpy
parent9d63daee9d7bc050aef46f3a22efed06d9baed4b (diff)
downloadnumpy-2c4f794b9ed9618cb8187af98eb59b73bb380e2e.tar.gz
DOC: Improve documentation comment from PR 274 comment
Diffstat (limited to 'numpy')
-rw-r--r--numpy/core/src/multiarray/descriptor.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/numpy/core/src/multiarray/descriptor.c b/numpy/core/src/multiarray/descriptor.c
index 6e0009662..4d72c7158 100644
--- a/numpy/core/src/multiarray/descriptor.c
+++ b/numpy/core/src/multiarray/descriptor.c
@@ -37,8 +37,9 @@ _use_inherit(PyArray_Descr *type, PyObject *newobj, int *errflag);
/*
* Creates a dtype object from ctypes inputs.
*
- * Returns NULL if this is not possible, but does not
- * set a Python exception.
+ * Returns a new reference to a dtype object, or NULL
+ * if this is not possible. When it returns NULL, it does
+ * not set a Python exception.
*/
static PyArray_Descr *
_arraydescr_fromctypes(PyObject *obj)
@@ -100,8 +101,9 @@ _arraydescr_fromctypes(PyObject *obj)
* - The object is a ctypes type object, including array
* and structure types.
*
- * Returns NULL if this is not possible, but does not
- * set a Python exception.
+ * Returns a new reference to a dtype object, or NULL
+ * if this is not possible. When it returns NULL, it does
+ * not set a Python exception.
*/
NPY_NO_EXPORT PyArray_Descr *
_arraydescr_fromobj(PyObject *obj)