Skip to content

Commit 3fd61b7

Browse files
Use soft-deprecated in more places (#148769)
1 parent 983c746 commit 3fd61b7

File tree

10 files changed

+29
-16
lines changed

10 files changed

+29
-16
lines changed

Doc/c-api/buffer.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,9 @@ readonly, format
258258

259259
.. c:macro:: PyBUF_WRITEABLE
260260
261-
This is a :term:`soft deprecated` alias to :c:macro:`PyBUF_WRITABLE`.
261+
This is an alias to :c:macro:`PyBUF_WRITABLE`.
262+
263+
.. soft-deprecated:: 3.13
262264

263265
.. c:macro:: PyBUF_FORMAT
264266

Doc/c-api/code.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,14 +212,16 @@ bound into a function.
212212
213213
.. c:function:: PyObject *PyCode_Optimize(PyObject *code, PyObject *consts, PyObject *names, PyObject *lnotab_obj)
214214
215-
This is a :term:`soft deprecated` function that does nothing.
215+
This is a function that does nothing.
216216
217217
Prior to Python 3.10, this function would perform basic optimizations to a
218218
code object.
219219
220220
.. versionchanged:: 3.10
221221
This function now does nothing.
222222
223+
.. soft-deprecated:: 3.13
224+
223225
224226
.. _c_codeobject_flags:
225227

Doc/c-api/descriptor.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,14 +140,16 @@ found in the dictionary of type objects.
140140
141141
.. c:macro:: PyDescr_COMMON
142142
143-
This is a :term:`soft deprecated` macro including the common fields for a
143+
This is a macro including the common fields for a
144144
descriptor object.
145145
146146
This was included in Python's C API by mistake; do not use it in extensions.
147147
For creating custom descriptor objects, create a class implementing the
148148
descriptor protocol (:c:member:`~PyTypeObject.tp_descr_get` and
149149
:c:member:`~PyTypeObject.tp_descr_set`).
150150
151+
.. soft-deprecated:: 3.15
152+
151153
152154
Built-in descriptors
153155
^^^^^^^^^^^^^^^^^^^^

Doc/c-api/exceptions.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -818,14 +818,16 @@ Exception Classes
818818
819819
.. c:macro:: PyException_HEAD
820820
821-
This is a :term:`soft deprecated` macro including the base fields for an
821+
This is a macro including the base fields for an
822822
exception object.
823823
824824
This was included in Python's C API by mistake and is not designed for use
825825
in extensions. For creating custom exception objects, use
826826
:c:func:`PyErr_NewException` or otherwise create a class inheriting from
827827
:c:data:`PyExc_BaseException`.
828828
829+
.. soft-deprecated:: 3.15
830+
829831
830832
Exception Objects
831833
=================

Doc/c-api/gen.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ Deprecated API
9090
9191
.. c:macro:: PyAsyncGenASend_CheckExact(op)
9292
93-
This is a :term:`soft deprecated` API that was included in Python's C API
93+
This is an API that was included in Python's C API
9494
by mistake.
9595
9696
It is solely here for completeness; do not use this API.
97+
98+
.. soft-deprecated:: 3.14

Doc/c-api/intro.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -587,10 +587,10 @@ have been standardized in C11 (or previous standards).
587587
588588
.. c:macro:: Py_MEMCPY(dest, src, n)
589589
590-
This is a :term:`soft deprecated` alias to :c:func:`!memcpy`.
591-
Use :c:func:`!memcpy` directly instead.
590+
This is an alias to :c:func:`!memcpy`.
592591
593592
.. soft-deprecated:: 3.14
593+
Use :c:func:`!memcpy` directly instead.
594594
595595
.. c:macro:: Py_UNICODE_SIZE
596596
@@ -611,8 +611,7 @@ have been standardized in C11 (or previous standards).
611611
612612
.. c:macro:: Py_VA_COPY
613613
614-
This is a :term:`soft deprecated` alias to the C99-standard ``va_copy``
615-
function.
614+
This is an alias to the C99-standard ``va_copy`` function.
616615
617616
Historically, this would use a compiler-specific method to copy a ``va_list``.
618617

Doc/c-api/set.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Deprecated API
201201
202202
.. c:macro:: PySet_MINSIZE
203203
204-
A :term:`soft deprecated` constant representing the size of an internal
204+
A constant representing the size of an internal
205205
preallocated table inside :c:type:`PySetObject` instances.
206206
207207
This is documented solely for completeness, as there are no guarantees
@@ -211,3 +211,5 @@ Deprecated API
211211
:c:macro:`!PySet_MINSIZE` can be replaced with a small constant like ``8``.
212212
213213
If looking for the size of a set, use :c:func:`PySet_Size` instead.
214+
215+
.. soft-deprecated:: 3.14

Doc/c-api/typeobj.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1391,8 +1391,8 @@ and :c:data:`PyType_Type` effectively act as defaults.)
13911391

13921392
.. versionchanged:: 3.9
13931393

1394-
Renamed to the current name, without the leading underscore.
1395-
The old provisional name is :term:`soft deprecated`.
1394+
Renamed to the current name, without the leading underscore.
1395+
The old provisional name is :term:`soft deprecated`.
13961396

13971397
.. versionchanged:: 3.12
13981398

@@ -1501,11 +1501,13 @@ and :c:data:`PyType_Type` effectively act as defaults.)
15011501

15021502
.. c:macro:: Py_TPFLAGS_HAVE_VERSION_TAG
15031503
1504-
This is a :term:`soft deprecated` macro that does nothing.
1504+
This macro does nothing.
15051505
Historically, this would indicate that the
15061506
:c:member:`~PyTypeObject.tp_version_tag` field was available and
15071507
initialized.
15081508

1509+
.. soft-deprecated:: 3.13
1510+
15091511

15101512
.. c:macro:: Py_TPFLAGS_INLINE_VALUES
15111513

Doc/library/ctypes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3190,8 +3190,8 @@ Arrays and pointers
31903190
Equivalent to ``type * length``, where *type* is a
31913191
:mod:`!ctypes` data type and *length* an integer.
31923192

3193-
This function is :term:`soft deprecated` in favor of multiplication.
3194-
There are no plans to remove it.
3193+
.. soft-deprecated:: 3.14
3194+
In favor of multiplication.
31953195

31963196

31973197
.. class:: _Pointer

Doc/library/mimetypes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ the information :func:`init` sets up.
5555
Added support for *url* being a :term:`path-like object`.
5656

5757
.. soft-deprecated:: 3.13
58-
Passing a file path instead of URL is :term:`soft deprecated`.
58+
Passing a file path instead of URL.
5959
Use :func:`guess_file_type` for this.
6060

6161

0 commit comments

Comments
 (0)