summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2020-10-14 15:22:21 +0300
committerGitHub <noreply@github.com>2020-10-14 15:22:21 +0300
commit820a439494aa8c5a199edadd6bf38af400f67caa (patch)
tree38b4088a6544b1bea0ca8c333637820f6b9a88d5
parenteb2c75189c9814dd463e0019419360b860d59ec1 (diff)
parent82c03d34c4a36f44b951a00efa901cf41457e1f3 (diff)
downloadnumpy-820a439494aa8c5a199edadd6bf38af400f67caa.tar.gz
Merge pull request #17555 from takanori-pskq/fix-wrong-blockquotes
DOC: Fix wrong blockquotes
-rw-r--r--doc/source/reference/arrays.interface.rst8
-rw-r--r--doc/source/user/c-info.how-to-extend.rst10
2 files changed, 0 insertions, 18 deletions
diff --git a/doc/source/reference/arrays.interface.rst b/doc/source/reference/arrays.interface.rst
index 49772a298..aeac66f82 100644
--- a/doc/source/reference/arrays.interface.rst
+++ b/doc/source/reference/arrays.interface.rst
@@ -60,7 +60,6 @@ This approach to the interface consists of the object having an
The keys are:
**shape** (required)
-
Tuple whose elements are the array size in each dimension. Each
entry is an integer (a Python int or long). Note that these
integers could be larger than the platform "int" or "long"
@@ -70,7 +69,6 @@ This approach to the interface consists of the object having an
:c:data:`Py_LONG_LONG` as the C type for the shapes.
**typestr** (required)
-
A string providing the basic type of the homogeneous array The
basic string format consists of 3 parts: a character describing
the byteorder of the data (``<``: little-endian, ``>``:
@@ -97,7 +95,6 @@ This approach to the interface consists of the object having an
===== ================================================================
**descr** (optional)
-
A list of tuples providing a more detailed description of the
memory layout for each item in the homogeneous array. Each
tuple in the list has two or three elements. Normally, this
@@ -127,7 +124,6 @@ This approach to the interface consists of the object having an
**Default**: ``[('', typestr)]``
**data** (optional)
-
A 2-tuple whose first argument is an integer (a long integer
if necessary) that points to the data-area storing the array
contents. This pointer must point to the first element of
@@ -148,7 +144,6 @@ This approach to the interface consists of the object having an
**Default**: None
**strides** (optional)
-
Either None to indicate a C-style contiguous array or
a Tuple of strides which provides the number of bytes needed
to jump to the next array element in the corresponding
@@ -166,7 +161,6 @@ This approach to the interface consists of the object having an
**Default**: None (C-style contiguous)
**mask** (optional)
-
None or an object exposing the array interface. All
elements of the mask array should be interpreted only as true
or not true indicating which elements of this array are valid.
@@ -177,7 +171,6 @@ This approach to the interface consists of the object having an
**Default**: None (All array values are valid)
**offset** (optional)
-
An integer offset into the array data region. This can only be
used when data is None or returns a :class:`buffer`
object.
@@ -185,7 +178,6 @@ This approach to the interface consists of the object having an
**Default**: 0.
**version** (required)
-
An integer showing the version of the interface (i.e. 3 for
this version). Be careful not to use this to invalidate
objects exposing future versions of the interface.
diff --git a/doc/source/user/c-info.how-to-extend.rst b/doc/source/user/c-info.how-to-extend.rst
index d75242092..845ce0a74 100644
--- a/doc/source/user/c-info.how-to-extend.rst
+++ b/doc/source/user/c-info.how-to-extend.rst
@@ -363,7 +363,6 @@ particular set of requirements ( *e.g.* contiguous, aligned, and
writeable). The syntax is
:c:func:`PyArray_FROM_OTF`
-
Return an ndarray from any Python object, *obj*, that can be
converted to an array. The number of dimensions in the returned
array is determined by the object. The desired data-type of the
@@ -375,7 +374,6 @@ writeable). The syntax is
exception is set.
*obj*
-
The object can be any Python object convertible to an ndarray.
If the object is already (a subclass of) the ndarray that
satisfies the requirements then a new reference is returned.
@@ -394,7 +392,6 @@ writeable). The syntax is
to the requirements flag.
*typenum*
-
One of the enumerated types or :c:data:`NPY_NOTYPE` if the data-type
should be determined from the object itself. The C-based names
can be used:
@@ -422,7 +419,6 @@ writeable). The syntax is
requirements flag to override this behavior.
*requirements*
-
The memory model for an ndarray admits arbitrary strides in
each dimension to advance to the next element of the array.
Often, however, you need to interface with code that expects a
@@ -446,13 +442,11 @@ writeable). The syntax is
:c:data:`NPY_OUT_ARRAY`, and :c:data:`NPY_ARRAY_INOUT_ARRAY`:
:c:data:`NPY_ARRAY_IN_ARRAY`
-
This flag is useful for arrays that must be in C-contiguous
order and aligned. These kinds of arrays are usually input
arrays for some algorithm.
:c:data:`NPY_ARRAY_OUT_ARRAY`
-
This flag is useful to specify an array that is
in C-contiguous order, is aligned, and can be written to
as well. Such an array is usually returned as output
@@ -460,7 +454,6 @@ writeable). The syntax is
scratch).
:c:data:`NPY_ARRAY_INOUT_ARRAY`
-
This flag is useful to specify an array that will be used for both
input and output. :c:func:`PyArray_ResolveWritebackIfCopy`
must be called before :c:func:`Py_DECREF` at
@@ -479,16 +472,13 @@ writeable). The syntax is
Other useful flags that can be OR'd as additional requirements are:
:c:data:`NPY_ARRAY_FORCECAST`
-
Cast to the desired type, even if it can't be done without losing
information.
:c:data:`NPY_ARRAY_ENSURECOPY`
-
Make sure the resulting array is a copy of the original.
:c:data:`NPY_ARRAY_ENSUREARRAY`
-
Make sure the resulting object is an actual ndarray and not a sub-
class.