8000 Suffix list items with 'instead.' · python/cpython@c106726 · GitHub
[go: up one dir, main page]

Skip to content

Commit c106726

Browse files
committed
Suffix list items with 'instead.'
1 parent 0171dad commit c106726

File tree

3 files changed

+58
-58
lines changed

3 files changed

+58
-58
lines changed

Doc/deprecations/c-api-pending-removal-in-3.14.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,38 @@ Pending Removal in Python 3.14
99

1010
* Functions to configure Python's initialization, deprecated in Python 3.11:
1111

12-
* ``PySys_SetArgvEx()``: set :c:member:`PyConfig.argv`
13-
* ``PySys_SetArgv()``: set :c:member:`PyConfig.argv`
14-
* ``Py_SetProgramName()``: set :c:member:`PyConfig.program_name`
15-
* ``Py_SetPythonHome()``: set :c:member:`PyConfig.home`
12+
* ``PySys_SetArgvEx()``: set :c:member:`PyConfig.argv` instead.
13+
* ``PySys_SetArgv()``: set :c:member:`PyConfig.argv` instead.
14+
* ``Py_SetProgramName()``: set :c:member:`PyConfig.program_name` instead.
15+
* ``Py_SetPythonHome()``: set :c:member:`PyConfig.home` instead.
1616

1717
The :c:func:`Py_InitializeFromConfig` API should be used with
1818
:c:type:`PyConfig` instead.
1919

2020
* Global configuration variables:
2121

22-
* :c:var:`Py_DebugFlag`: use :c:member:`PyConfig.parser_debug`
23-
* :c:var:`Py_VerboseFlag`: use :c:member:`PyConfig.verbose`
24-
* :c:var:`Py_QuietFlag`: use :c:member:`PyConfig.quiet`
25-
* :c:var:`Py_InteractiveFlag`: use :c:member:`PyConfig.interactive`
26-
* :c:var:`Py_InspectFlag`: use :c:member:`PyConfig.inspect`
27-
* :c:var:`Py_OptimizeFlag`: use :c:member:`PyConfig.optimization_level`
28-
* :c:var:`Py_NoSiteFlag`: use :c:member:`PyConfig.site_import`
29-
* :c:var:`Py_BytesWarningFlag`: use :c:member:`PyConfig.bytes_warning`
30-
* :c:var:`Py_FrozenFlag`: use :c:member:`PyConfig.pathconfig_warnings`
31-
* :c:var:`Py_IgnoreEnvironmentFlag`: use :c:member:`PyConfig.use_environment`
32-
* :c:var:`Py_DontWriteBytecodeFlag`: use :c:member:`PyConfig.write_bytecode`
33-
* :c:var:`Py_NoUserSiteDirectory`: use :c:member:`PyConfig.user_site_directory`
34-
* :c:var:`Py_UnbufferedStdioFlag`: use :c:member:`PyConfig.buffered_stdio`
22+
* :c:var:`Py_DebugFlag`: use :c:member:`PyConfig.parser_debug` instead.
23+
* :c:var:`Py_VerboseFlag`: use :c:member:`PyConfig.verbose` instead.
24+
* :c:var:`Py_QuietFlag`: use :c:member:`PyConfig.quiet` instead.
25+
* :c:var:`Py_InteractiveFlag`: use :c:member:`PyConfig.interactive` instead.
26+
* :c:var:`Py_InspectFlag`: use :c:member:`PyConfig.inspect` instead.
27+
* :c:var:`Py_OptimizeFlag`: use :c:member:`PyConfig.optimization_level` instead.
28+
* :c:var:`Py_NoSiteFlag`: use :c:member:`PyConfig.site_import` instead.
29+
* :c:var:`Py_BytesWarningFlag`: use :c:member:`PyConfig.bytes_warning` instead.
30+
* :c:var:`Py_FrozenFlag`: use :c:member:`PyConfig.pathconfig_warnings` instead.
31+
* :c:var:`Py_IgnoreEnvironmentFlag`: use :c:member:`PyConfig.use_environment` instead.
32+
* :c:var:`Py_DontWriteBytecodeFlag`: use :c:member:`PyConfig.write_bytecode` instead.
33+
* :c:var:`Py_NoUserSiteDirectory`: use :c:member:`PyConfig.user_site_directory` instead.
34+
* :c:var:`Py_UnbufferedStdioFlag`: use :c:member:`PyConfig.buffered_stdio` instead.
3535
* :c:var:`Py_HashRandomizationFlag`: use :c:member:`PyConfig.use_hash_seed`
36-
and :c:member:`PyConfig.hash_seed`
37-
* :c:var:`Py_IsolatedFlag`: use :c:member:`PyConfig.isolated`
38-
* :c:var:`Py_LegacyWindowsFSEncodingFlag`: use :c:member:`PyPreConfig.legacy_windows_fs_encoding`
39-
* :c:var:`Py_LegacyWindowsStdioFlag`: use :c:member:`PyConfig.legacy_windows_stdio`
40-
* :c:var:`!Py_FileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`
41-
* :c:var:`!Py_HasFileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`
42-
* :c:var:`!Py_FileSystemDefaultEncodeErrors`: use :c:member:`PyConfig.filesystem_errors`
43-
* :c:var:`!Py_UTF8Mode`: use :c:member:`PyPreConfig.utf8_mode` (see :c:func:`Py_PreInitialize`)
36+
and :c:member:`PyConfig.hash_seed` instead.
37+
* :c:var:`Py_IsolatedFlag`: use :c:member:`PyConfig.isolated` instead.
38+
* :c:var:`Py_LegacyWindowsFSEncodingFlag`: use :c:member:`PyPreConfig.legacy_windows_fs_encoding` instead.
39+
* :c:var:`Py_LegacyWindowsStdioFlag`: use :c:member:`PyConfig.legacy_windows_stdio` instead.
40+
* :c:var:`!Py_FileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding` instead.
41+
* :c:var:`!Py_HasFileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding` instead.
42+
* :c:var:`!Py_FileSystemDefaultEncodeErrors`: use :c:member:`PyConfig.filesystem_errors` instead.
43+
* :c:var:`!Py_UTF8Mode`: use :c:member:`PyPreConfig.utf8_mode` instead. (see :c:func:`Py_PreInitialize`)
4444

4545
The :c:func:`Py_InitializeFromConfig` API should be used with
4646
:c:type:`PyConfig` instead.

Doc/deprecations/c-api-pending-removal-in-3.15.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@ Pending Removal in Python 3.15
22
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33

44
* The bundled copy of ``libmpdecimal``.
5-
* :c:func:`PyImport_ImportModuleNoBlock`: use :c:func:`PyImport_ImportModule`
6-
* :c:func:`PyWeakref_GET_OBJECT`: use :c:func:`PyWeakref_GetRef`
7-
* :c:func:`PyWeakref_GetObject`: use :c:func:`PyWeakref_GetRef`
8-
* :c:type:`!Py_UNICODE_WIDE` type: use :c:type:`wchar_t`
9-
* :c:type:`Py_UNICODE` type: use :c:type:`wchar_t`
5+
* :c:func:`PyImport_ImportModuleNoBlock`: use :c:func:`PyImport_ImportModule` instead.
6+
* :c:func:`PyWeakref_GET_OBJECT`: use :c:func:`PyWeakref_GetRef` instead.
7+
* :c:func:`PyWeakref_GetObject`: use :c:func:`PyWeakref_GetRef` instead.
8+
* :c:type:`!Py_UNICODE_WIDE` type: use :c:type:`wchar_t` instead.
9+
* :c:type:`Py_UNICODE` type: use :c:type:`wchar_t` instead.
1010
* Python initialization functions:
1111

1212
* :c:func:`PySys_ResetWarnOptions`: clear :data:`sys.warnoptions` and
13-
:data:`!warnings.filters`
14-
* :c:func:`Py_GetExecPrefix`: get :data:`sys.exec_prefix`
15-
* :c:func:`Py_GetPath`: get :data:`sys.path`
16-
* :c:func:`Py_GetPrefix`: get :data:`sys.prefix`
17-
* :c:func:`Py_GetProgramFullPath`: get :data:`sys.executable`
18-
* :c:func:`Py_GetProgramName`: get :data:`sys.executable`
13+
:data:`!warnings.filters` instead.
14+
* :c:func:`Py_GetExecPrefix`: get :data:`sys.exec_prefix` instead.
15+
* :c:func:`Py_GetPath`: get :data:`sys.path` instead.
16+
* :c:func:`Py_GetPrefix`: get :data:`sys.prefix` instead.
17+
* :c:func:`Py_GetProgramFullPath`: get :data:`sys.executable` instead.
18+
* :c:func:`Py_GetProgramName`: get :data:`sys.executable` instead.
1919
* :c:func:`Py_GetPythonHome`: get :c:member:`PyConfig.home` or
20-
the :envvar:`PYTHONHOME` environment variable
20+
the :envvar:`PYTHONHOME` environment variable instead.

Doc/deprecations/c-api-pending-removal-in-future.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@ Pending Removal in Future Versions
44
The following APIs are deprecated and will be removed,
55
although there is currently no date scheduled for their removal.
66

7-
* :c:macro:`Py_TPFLAGS_HAVE_FINALIZE`: unneeded since Python 3.8
8-
* :c:func:`PyErr_Fetch`: use :c:func:`PyErr_GetRaisedException`
9-
* :c:func:`PyErr_NormalizeException`: use :c:func:`PyErr_GetRaisedException`
10-
* :c:func:`PyErr_Restore`: use :c:func:`PyErr_SetRaisedException`
11-
* :c:func:`PyModule_GetFilename`: use :c:func:`PyModule_GetFilenameObject`
12-
* :c:func:`PyOS_AfterFork`: use :c:func:`PyOS_AfterFork_Child`
13-
* :c:func:`PySlice_GetIndicesEx`: use :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices`
14-
* :c:func:`!PyUnicode_AsDecodedObject`: use :c:func:`PyCodec_Decode`
15-
* :c:func:`!PyUnicode_AsDecodedUnicode`: use :c:func:`PyCodec_Decode`
16-
* :c:func:`!PyUnicode_AsEncodedObject`: use :c:func:`PyCodec_Encode`
17-
* :c:func:`!PyUnicode_AsEncodedUnicode`: use :c:func:`PyCodec_Encode`
7+
* :c:macro:`Py_TPFLAGS_HAVE_FINALIZE`: unneeded since Python 3.8.
8+
* :c:func:`PyErr_Fetch`: use :c:func:`PyErr_GetRaisedException` instead.
9+
* :c:func:`PyErr_NormalizeException`: use :c:func:`PyErr_GetRaisedException` instead.
10+
* :c:func:`PyErr_Restore`: use :c:func:`PyErr_SetRaisedException` instead.
11+
* :c:func:`PyModule_GetFilename`: use :c:func:`PyModule_GetFilenameObject` instead.
12+
* :c:func:`PyOS_AfterFork`: use :c:func:`PyOS_AfterFork_Child` instead.
13+
* :c:func:`PySlice_GetIndicesEx`: use :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices` instead.
14+
* :c:func:`!PyUnicode_AsDecodedObject`: use :c:func:`PyCodec_Decode` instead.
15+
* :c:func:`!PyUnicode_AsDecodedUnicode`: use :c:func:`PyCodec_Decode` instead.
16+
* :c:func:`!PyUnicode_AsEncodedObject`: use :c:func:`PyCodec_Encode` instead.
17+
* :c:func:`!PyUnicode_AsEncodedUnicode`: use :c:func:`PyCodec_Encode` instead.
1818
* :c:func:`PyUnicode_READY`: unneeded since Python 3.12
19-
* :c:func:`!PyErr_Display`: use :c:func:`PyErr_DisplayException`
20-
* :c:func:`!_PyErr_ChainExceptions`: use ``_PyErr_ChainExceptions1``
19+
* :c:func:`!PyErr_Display`: use :c:func:`PyErr_DisplayException` instead.
20+
* :c:func:`!_PyErr_ChainExceptions`: use ``_PyErr_ChainExceptions1`` instead.
2121
* :c:member:`!PyBytesObject.ob_shash` member:
22-
call :c:func:`PyObject_Hash` instead
23-
* :c:member:`!PyDictObject.ma_version_tag` member
22+
call :c:func:`PyObject_Hash` instead.
23+
* :c:member:`!PyDictObject.ma_version_tag` member.
2424
* Thread Local Storage (TLS) API:
2525

26-
* :c:func:`PyThread_create_key`: use :c:func:`PyThread_tss_alloc`
27-
* :c:func:`PyThread_delete_key`: use :c:func:`PyThread_tss_free`
28-
* :c:func:`PyThread_set_key_value`: use :c:func:`PyThread_tss_set`
29-
* :c:func:`PyThread_get_key_value`: use :c:func:`PyThread_tss_get`
30-
* :c:func:`PyThread_delete_key_value`: use :c:func:`PyThread_tss_delete`
31-
* :c:func:`PyThread_ReInitTLS`: unneeded since Python 3.7
26+
* :c:func:`PyThread_create_key`: use :c:func:`PyThread_tss_alloc` instead.
27+
* :c:func:`PyThread_delete_key`: use :c:func:`PyThread_tss_free` instead.
28+
* :c:func:`PyThread_set_key_value`: use :c:func:`PyThread_tss_set` instead.
29+
* :c:func:`PyThread_get_key_value`: use :c:func:`PyThread_tss_get` instead.
30+
* :c:func:`PyThread_delete_key_value`: use :c:func:`PyThread_tss_delete` instead.
31+
* :c:func:`PyThread_ReInitTLS`: unneeded since Python 3.7.
3232

3333
* Remove undocumented ``PY_TIMEOUT_MAX`` constant from the limited C API.
3434
(Contributed by Victor Stinner in :gh:`110014`.)

0 commit comments

Comments
 (0)
0