Skip to content

Commit 18b9ffd

Browse files
authored
Merge pull request numpy#27454 from SMAntony/pycon-doc
DOC: Remove outdated versionadded/changed directives
2 parents 7e6e48c + 9fc06fc commit 18b9ffd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+14
-929
lines changed

doc/source/reference/arrays.datetime.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
Datetimes and timedeltas
77
************************
88

9-
.. versionadded:: 1.7.0
10-
119
Starting in NumPy 1.7, there are core array data types which natively
1210
support datetime functionality. The data type is called :class:`datetime64`,
1311
so named because :class:`~datetime.datetime` is already taken by the Python standard library.

doc/source/reference/c-api/array.rst

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,11 @@ and its sub-types).
6666
6767
.. c:function:: void PyArray_ENABLEFLAGS(PyArrayObject* arr, int flags)
6868
69-
.. versionadded:: 1.7
70-
7169
Enables the specified array flags. This function does no validation,
7270
and assumes that you know what you're doing.
7371
7472
.. c:function:: void PyArray_CLEARFLAGS(PyArrayObject* arr, int flags)
7573
76-
.. versionadded:: 1.7
77-
7874
Clears the specified array flags. This function does no validation,
7975
and assumes that you know what you're doing.
8076
@@ -97,8 +93,6 @@ and its sub-types).
9793
9894
.. c:function:: npy_intp *PyArray_SHAPE(PyArrayObject *arr)
9995
100-
.. versionadded:: 1.7
101-
10296
A synonym for :c:func:`PyArray_DIMS`, named to be consistent with the
10397
`shape <numpy.ndarray.shape>` usage within Python.
10498
@@ -157,8 +151,6 @@ and its sub-types).
157151
158152
.. c:function:: PyArray_Descr *PyArray_DTYPE(PyArrayObject* arr)
159153
160-
.. versionadded:: 1.7
161-
162154
A synonym for PyArray_DESCR, named to be consistent with the
163155
'dtype' usage within Python.
164156
@@ -275,8 +267,6 @@ From scratch
275267
PyArrayObject* prototype, NPY_ORDER order, PyArray_Descr* descr, \
276268
int subok)
277269
278-
.. versionadded:: 1.6
279-
280270
This function steals a reference to *descr* if it is not NULL.
281271
This array creation routine allows for the convenient creation of
282272
a new array matching an existing array's shapes and memory layout,
@@ -406,8 +396,6 @@ From scratch
406396
407397
.. c:function:: int PyArray_SetBaseObject(PyArrayObject* arr, PyObject* obj)
408398
409-
.. versionadded:: 1.7
410-
411399
This function **steals a reference** to ``obj`` and sets it as the
412400
base property of ``arr``.
413401
@@ -934,8 +922,6 @@ argument must be a :c:expr:`PyObject *` that can be directly interpreted as a
934922
called on flexible dtypes. Types that are attached to an array will always
935923
be sized, hence the array form of this macro not existing.
936924
937-
.. versionchanged:: 1.18
938-
939925
For structured datatypes with no fields this function now returns False.
940926
941927
.. c:function:: int PyTypeNum_ISUSERDEF(int num)
@@ -1065,8 +1051,6 @@ Converting data types
10651051
.. c:function:: int PyArray_CanCastTypeTo( \
10661052
PyArray_Descr* fromtype, PyArray_Descr* totype, NPY_CASTING casting)
10671053
1068-
.. versionadded:: 1.6
1069-
10701054
Returns non-zero if an array of data type *fromtype* (which can
10711055
include flexible types) can be cast safely to an array of data
10721056
type *totype* (which can include flexible types) according to
@@ -1081,8 +1065,6 @@ Converting data types
10811065
.. c:function:: int PyArray_CanCastArrayTo( \
10821066
PyArrayObject* arr, PyArray_Descr* totype, NPY_CASTING casting)
10831067
1084-
.. versionadded:: 1.6
1085-
10861068
Returns non-zero if *arr* can be cast to *totype* according
10871069
to the casting rule given in *casting*. If *arr* is an array
10881070
scalar, its value is taken into account, and non-zero is also
@@ -1096,8 +1078,6 @@ Converting data types
10961078
internally. It is currently provided for backwards compatibility,
10971079
but expected to be eventually deprecated.
10981080
1099-
.. versionadded:: 1.6
1100-
11011081
If *arr* is an array, returns its data type descriptor, but if
11021082
*arr* is an array scalar (has 0 dimensions), it finds the data type
11031083
of smallest size to which the value may be converted
@@ -1110,8 +1090,6 @@ Converting data types
11101090
.. c:function:: PyArray_Descr* PyArray_PromoteTypes( \
11111091
PyArray_Descr* type1, PyArray_Descr* type2)
11121092
1113-
.. versionadded:: 1.6
1114-
11151093
Finds the data type of smallest size and kind to which *type1* and
11161094
*type2* may be safely converted. This function is symmetric and
11171095
associative. A string or unicode result will be the proper size for
@@ -1121,8 +1099,6 @@ Converting data types
11211099
npy_intp narrs, PyArrayObject **arrs, npy_intp ndtypes, \
11221100
PyArray_Descr **dtypes)
11231101
1124-
.. versionadded:: 1.6
1125-
11261102
This applies type promotion to all the input arrays and dtype
11271103
objects, using the NumPy rules for combining scalars and arrays, to
11281104
determine the output type for an operation with the given set of
@@ -1161,11 +1137,6 @@ Converting data types
11611137
``DECREF`` 'd or a memory-leak will occur. The example template-code
11621138
below shows a typical usage:
11631139
1164-
.. versionchanged:: 1.18.0
1165-
A mix of scalars and zero-dimensional arrays now produces a type
1166-
capable of holding the scalar value.
1167-
Previously priority was given to the dtype of the arrays.
1168-
11691140
.. code-block:: c
11701141
11711142
mps = PyArray_ConvertToCommonType(obj, &n);
@@ -2421,8 +2392,6 @@ Item selection and manipulation
24212392
24222393
.. c:function:: npy_intp PyArray_CountNonzero(PyArrayObject* self)
24232394
2424-
.. versionadded:: 1.6
2425-
24262395
Counts the number of non-zero elements in the array object *self*.
24272396
24282397
.. c:function:: PyObject* PyArray_Nonzero(PyArrayObject* self)
@@ -2682,8 +2651,6 @@ Array Functions
26822651
.. c:function:: PyObject* PyArray_MatrixProduct2( \
26832652
PyObject* obj1, PyObject* obj, PyArrayObject* out)
26842653
2685-
.. versionadded:: 1.6
2686-
26872654
Same as PyArray_MatrixProduct, but store the result in *out*. The
26882655
output array must have the correct shape, type, and be
26892656
C-contiguous, or an exception is raised.
@@ -2693,8 +2660,6 @@ Array Functions
26932660
PyArray_Descr* dtype, NPY_ORDER order, NPY_CASTING casting, \
26942661
PyArrayObject* out)
26952662
2696-
.. versionadded:: 1.6
2697-
26982663
Applies the Einstein summation convention to the array operands
26992664
provided, returning a new array or placing the result in *out*.
27002665
The string in *subscripts* is a comma separated list of index
@@ -2786,8 +2751,6 @@ Other functions
27862751
Auxiliary data with object semantics
27872752
------------------------------------
27882753
2789-
.. versionadded:: 1.7.0
2790-
27912754
.. c:type:: NpyAuxData
27922755
27932756
When working with more complex dtypes which are composed of other dtypes,
@@ -3069,8 +3032,6 @@ Broadcasting (multi-iterators)
30693032
Neighborhood iterator
30703033
---------------------
30713034
3072-
.. versionadded:: 1.4.0
3073-
30743035
Neighborhood iterators are subclasses of the iterator object, and can be used
30753036
to iter over a neighborhood of a point. For example, you may want to iterate
30763037
over every voxel of a 3d image, and for every such voxel, iterate over an
@@ -4069,8 +4030,6 @@ extension with the lowest :c:data:`NPY_FEATURE_VERSION` as possible.
40694030
40704031
.. c:function:: unsigned int PyArray_GetNDArrayCFeatureVersion(void)
40714032
4072-
.. versionadded:: 1.4.0
4073-
40744033
This just returns the value :c:data:`NPY_FEATURE_VERSION`.
40754034
:c:data:`NPY_FEATURE_VERSION` changes whenever the API changes (e.g. a
40764035
function is added). A changed value does not always require a recompile.
@@ -4467,8 +4426,6 @@ Enumerated Types
44674426
44684427
.. c:enum:: NPY_CASTING
44694428
4470-
.. versionadded:: 1.6
4471-
44724429
An enumeration type indicating how permissive data conversions should
44734430
be. This is used by the iterator added in NumPy 1.6, and is intended
44744431
to be used more broadly in a future version.

doc/source/reference/c-api/coremath.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,6 @@ Those can be useful for precise floating point comparison.
185185
* NPY_FPE_UNDERFLOW
186186
* NPY_FPE_INVALID
187187
188-
.. versionadded:: 1.15.0
189-
190188
.. c:function:: int npy_clear_floatstatus()
191189
192190
Clears the floating point status. Returns the previous status mask.
@@ -201,8 +199,6 @@ Those can be useful for precise floating point comparison.
201199
prevent aggressive compiler optimizations from reordering this function call.
202200
Returns the previous status mask.
203201
204-
.. versionadded:: 1.15.0
205-
206202
.. _complex-numbers:
207203
208204
Support for complex numbers

doc/source/reference/c-api/dtype.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
13
Data type API
24
=============
35

doc/source/reference/c-api/iterator.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ Array iterator API
77
pair: iterator; C-API
88
pair: C-API; iterator
99

10-
.. versionadded:: 1.6
11-
1210
Array iterator
1311
--------------
1412

@@ -639,8 +637,6 @@ Construction and destruction
639637
640638
.. c:macro:: NPY_ITER_ARRAYMASK
641639
642-
.. versionadded:: 1.7
643-
644640
Indicates that this operand is the mask to use for
645641
selecting elements when writing to operands which have
646642
the :c:data:`NPY_ITER_WRITEMASKED` flag applied to them.
@@ -663,8 +659,6 @@ Construction and destruction
663659
664660
.. c:macro:: NPY_ITER_WRITEMASKED
665661
666-
.. versionadded:: 1.7
667-
668662
This array is the mask for all `writemasked <numpy.nditer>`
669663
operands. Code uses the ``writemasked`` flag which indicates
670664
that only elements where the chosen ARRAYMASK operand is True
@@ -1127,8 +1121,6 @@ Construction and destruction
11271121
11281122
.. c:function:: npy_bool NpyIter_IsFirstVisit(NpyIter* iter, int iop)
11291123
1130-
.. versionadded:: 1.7
1131-
11321124
Checks to see whether this is the first time the elements of the
11331125
specified reduction operand which the iterator points at are being
11341126
seen for the first time. The function returns a reasonable answer

doc/source/reference/random/c-api.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ C API for random
33

44
.. currentmodule:: numpy.random
55

6-
.. versionadded:: 1.19.0
7-
86
Access to various distributions below is available via Cython or C-wrapper
97
libraries like CFFI. All the functions accept a :c:type:`bitgen_t` as their
108
first argument. To access these from Cython or C, you must link with the

doc/source/reference/routines.linalg.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,6 @@ Exceptions
139139
Linear algebra on several matrices at once
140140
------------------------------------------
141141

142-
.. versionadded:: 1.8.0
143-
144142
Several of the linear algebra routines listed above are able to
145143
compute results for several matrices at once, if they are stacked into
146144
the same array.

doc/source/reference/routines.polynomials.chebyshev.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. versionadded:: 1.4.0
2-
31
.. automodule:: numpy.polynomial.chebyshev
42
:no-members:
53
:no-inherited-members:

doc/source/reference/routines.polynomials.hermite.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. versionadded:: 1.6.0
2-
31
.. automodule:: numpy.polynomial.hermite
42
:no-members:
53
:no-inherited-members:

doc/source/reference/routines.polynomials.laguerre.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. versionadded:: 1.6.0
2-
31
.. automodule:: numpy.polynomial.laguerre
42
:no-members:
53
:no-inherited-members:

0 commit comments

Comments
 (0)