diff options
author | Michael Seifert <michaelseifert04@yahoo.de> | 2017-03-28 01:02:44 +0200 |
---|---|---|
committer | Michael Seifert <michaelseifert04@yahoo.de> | 2017-03-28 01:31:10 +0200 |
commit | 5b0e3aa11ac5ae7b16ae6c2d72bb5624d3c124bc (patch) | |
tree | 895c5d8df8527dc892b0b3a9985d839b121e856c /doc/source/user | |
parent | 0a1697f7802d864d5e417d913bfe1c9cd6740268 (diff) | |
download | numpy-5b0e3aa11ac5ae7b16ae6c2d72bb5624d3c124bc.tar.gz |
DOC: Unwrap long signature lines
[skip ci]
Diffstat (limited to 'doc/source/user')
-rw-r--r-- | doc/source/user/c-info.beyond-basics.rst | 7 | ||||
-rw-r--r-- | doc/source/user/c-info.how-to-extend.rst | 15 | ||||
-rw-r--r-- | doc/source/user/c-info.ufunc-tutorial.rst | 7 |
3 files changed, 20 insertions, 9 deletions
diff --git a/doc/source/user/c-info.beyond-basics.rst b/doc/source/user/c-info.beyond-basics.rst index e91f23182..1f19c8405 100644 --- a/doc/source/user/c-info.beyond-basics.rst +++ b/doc/source/user/c-info.beyond-basics.rst @@ -284,7 +284,8 @@ functions for each conversion you want to support and then registering these functions with the data-type descriptor. A low-level casting function has the signature. -.. c:function:: void castfunc( void* from, void* to, npy_intp n, void* fromarr, void* toarr) +.. c:function:: void castfunc( \ + void* from, void* to, npy_intp n, void* fromarr, void* toarr) Cast ``n`` elements ``from`` one type ``to`` another. The data to cast from is in a contiguous, correctly-swapped and aligned chunk @@ -357,7 +358,9 @@ previously created. Then you call :c:func:`PyUFunc_RegisterLoopForType` this function is ``0`` if the process was successful and ``-1`` with an error condition set if it was not successful. -.. c:function:: int PyUFunc_RegisterLoopForType( PyUFuncObject* ufunc, int usertype, PyUFuncGenericFunction function, int* arg_types, void* data) +.. c:function:: int PyUFunc_RegisterLoopForType( \ + PyUFuncObject* ufunc, int usertype, PyUFuncGenericFunction function, \ + int* arg_types, void* data) *ufunc* diff --git a/doc/source/user/c-info.how-to-extend.rst b/doc/source/user/c-info.how-to-extend.rst index 6b7f95a84..a8b3de34f 100644 --- a/doc/source/user/c-info.how-to-extend.rst +++ b/doc/source/user/c-info.how-to-extend.rst @@ -90,11 +90,14 @@ that do not require a separate extraction of the module dictionary. These are documented in the Python documentation, but repeated here for convenience: -.. c:function:: int PyModule_AddObject(PyObject* module, char* name, PyObject* value) +.. c:function:: int PyModule_AddObject( \ + PyObject* module, char* name, PyObject* value) -.. c:function:: int PyModule_AddIntConstant(PyObject* module, char* name, long value) +.. c:function:: int PyModule_AddIntConstant( \ + PyObject* module, char* name, long value) -.. c:function:: int PyModule_AddStringConstant(PyObject* module, char* name, char* value) +.. c:function:: int PyModule_AddStringConstant( \ + PyObject* module, char* name, char* value) All three of these functions require the *module* object (the return value of Py_InitModule). The *name* is a string that @@ -359,7 +362,8 @@ specific builtin data-type ( *e.g.* float), while specifying a particular set of requirements ( *e.g.* contiguous, aligned, and writeable). The syntax is -.. c:function:: PyObject *PyArray_FROM_OTF(PyObject* obj, int typenum, int requirements) +.. c:function:: PyObject *PyArray_FROM_OTF( \ + PyObject* obj, int typenum, int requirements) Return an ndarray from any Python object, *obj*, that can be converted to an array. The number of dimensions in the returned @@ -529,7 +533,8 @@ simpler forms exist that are easier to use. memory for the array can be set to zero if desired using :c:func:`PyArray_FILLWBYTE` (return_object, 0). -.. c:function:: PyObject *PyArray_SimpleNewFromData( int nd, npy_intp* dims, int typenum, void* data) +.. c:function:: PyObject *PyArray_SimpleNewFromData( \ + int nd, npy_intp* dims, int typenum, void* data) Sometimes, you want to wrap memory allocated elsewhere into an ndarray object for downstream use. This routine makes it diff --git a/doc/source/user/c-info.ufunc-tutorial.rst b/doc/source/user/c-info.ufunc-tutorial.rst index 9d957528d..59e3dc6dc 100644 --- a/doc/source/user/c-info.ufunc-tutorial.rst +++ b/doc/source/user/c-info.ufunc-tutorial.rst @@ -1058,7 +1058,9 @@ What follows is the full specification of PyUFunc_FromFuncAndData, which automatically generates a ufunc from a C function with the correct signature. -.. c:function:: PyObject *PyUFunc_FromFuncAndData( PyUFuncGenericFunction* func, void** data, char* types, int ntypes, int nin, int nout, int identity, char* name, char* doc, int unused) +.. c:function:: PyObject *PyUFunc_FromFuncAndData( \ + PyUFuncGenericFunction* func, void** data, char* types, int ntypes, \ + int nin, int nout, int identity, char* name, char* doc, int unused) *func* @@ -1067,7 +1069,8 @@ automatically generates a ufunc from a C function with the correct signature. ``PyUFuncGenericFunction`` function. This function has the following signature. An example of a valid 1d loop function is also given. - .. c:function:: void loop1d(char** args, npy_intp* dimensions, npy_intp* steps, void* data) + .. c:function:: void loop1d( \ + char** args, npy_intp* dimensions, npy_intp* steps, void* data) *args* |