From 69a77fb790d6545969c17f7aed0fe160a6a5bc6a Mon Sep 17 00:00:00 2001 From: mattip Date: Mon, 30 Apr 2018 18:13:10 +0300 Subject: DOC: Clarify C-API for generalized ufuncs. --- doc/source/reference/c-api.generalized-ufuncs.rst | 7 ++++--- doc/source/reference/c-api.ufunc.rst | 7 ++++--- doc/source/reference/ufuncs.rst | 4 ++-- 3 files changed, 10 insertions(+), 8 deletions(-) (limited to 'doc/source/reference') diff --git a/doc/source/reference/c-api.generalized-ufuncs.rst b/doc/source/reference/c-api.generalized-ufuncs.rst index a53228cb5..dd8cf6558 100644 --- a/doc/source/reference/c-api.generalized-ufuncs.rst +++ b/doc/source/reference/c-api.generalized-ufuncs.rst @@ -101,6 +101,7 @@ Dimension Index enumerates the dimension names according to the order of the first occurrence of each name in the signature. +.. _details-of-signature: Details of Signature -------------------- @@ -126,9 +127,9 @@ The formal syntax of signatures is as follows:: ::= ::= nil | | "," ::= "(" ")" - ::= nil | | - "," - ::= valid Python variable name + ::= nil | | + "," + ::= valid Python variable name Notes: diff --git a/doc/source/reference/c-api.ufunc.rst b/doc/source/reference/c-api.ufunc.rst index 5ac34edc1..ece6cc391 100644 --- a/doc/source/reference/c-api.ufunc.rst +++ b/doc/source/reference/c-api.ufunc.rst @@ -135,10 +135,11 @@ Functions int nin, int nout, int identity, char* name, char* doc, int unused, char *signature) This function is very similar to PyUFunc_FromFuncAndData above, but has - an extra *signature* argument, to define generalized universal functions. + an extra *signature* argument, to define a + :ref:`generalized universal functions `. Similarly to how ufuncs are built around an element-by-element operation, - gufuncs are around subarray-by-subarray operations, the signature defining - the subarrays to operate on. + gufuncs are around subarray-by-subarray operations, the + :ref:`signature ` defining the subarrays to operate on. :param signature: The signature for the new gufunc. Setting it to NULL is equivalent diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst index 68d85ccf5..995542d77 100644 --- a/doc/source/reference/ufuncs.rst +++ b/doc/source/reference/ufuncs.rst @@ -424,8 +424,8 @@ advanced usage and will not typically be used. provided by the **types** attribute of the ufunc object. For backwards compatibility this argument can also be provided as *sig*, although the long form is preferred. Note that this should not be confused with - the generalized ufunc signature that is stored in the **signature** - attribute of the of the ufunc object. + the generalized ufunc :ref:`signature ` that is + stored in the **signature** attribute of the of the ufunc object. *extobj* -- cgit v1.2.1