diff options
| author | Jaime Fernandez <jaime.frio@gmail.com> | 2015-03-12 23:05:50 -0700 |
|---|---|---|
| committer | Jaime Fernandez <jaime.frio@gmail.com> | 2015-03-12 23:05:50 -0700 |
| commit | cb2405f6c82863c0f2263a077f0010584b36bbb3 (patch) | |
| tree | df2ce57027fd6bdefaf1623e9b28394656593c64 /doc/source | |
| parent | 533f616b0ca7be6efa28a7ae58db9235b4348d10 (diff) | |
| download | numpy-cb2405f6c82863c0f2263a077f0010584b36bbb3.tar.gz | |
DOC: 'signature' preferred over 'sig' as ufunc keyword argument
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/reference/ufuncs.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst index 3d5176638..a97534612 100644 --- a/doc/source/reference/ufuncs.rst +++ b/doc/source/reference/ufuncs.rst @@ -350,7 +350,8 @@ advanced usage and will not typically be used. .. versionadded:: 1.6 - Overrides the dtype of the calculation and output arrays. Similar to *sig*. + Overrides the dtype of the calculation and output arrays. Similar to + *signature*. *subok* @@ -359,7 +360,7 @@ advanced usage and will not typically be used. Defaults to true. If set to false, the output will always be a strict array, not a subtype. -*sig* or *signature* +*signature* Either a data-type, a tuple of data-types, or a special signature string indicating the input and output types of a ufunc. This argument @@ -370,7 +371,9 @@ advanced usage and will not typically be used. available and searching for a loop with data-types to which all inputs can be cast safely. This keyword argument lets you bypass that search and choose a particular loop. A list of available signatures is - provided by the **types** attribute of the ufunc object. + 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. *extobj* |