gh-101100: Fix Sphinx warnings for 2.6 port-specific deprecations (#113752)

This commit is contained in:
Hugo van Kemenade 2024-01-09 10:18:15 +02:00 committed by GitHub
parent 842b738129
commit 2e17cad2b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 75 additions and 81 deletions

View File

@ -130,7 +130,7 @@ Guidelines":
Read the rest of :pep:`1` for the details of the PEP editorial process, style, and Read the rest of :pep:`1` for the details of the PEP editorial process, style, and
format. PEPs are kept in the Python CVS tree on SourceForge, though they're not format. PEPs are kept in the Python CVS tree on SourceForge, though they're not
part of the Python 2.0 distribution, and are also available in HTML form from part of the Python 2.0 distribution, and are also available in HTML form from
https://peps.python.org/. As of September 2000, there are 25 PEPS, ranging https://peps.python.org/. As of September 2000, there are 25 PEPs, ranging
from :pep:`201`, "Lockstep Iteration", to PEP 225, "Elementwise/Objectwise from :pep:`201`, "Lockstep Iteration", to PEP 225, "Elementwise/Objectwise
Operators". Operators".

View File

@ -4,8 +4,6 @@
What's New in Python 2.6 What's New in Python 2.6
**************************** ****************************
.. XXX add trademark info for Apple, Microsoft, SourceForge.
:Author: A.M. Kuchling (amk at amk.ca) :Author: A.M. Kuchling (amk at amk.ca)
.. $Id$ .. $Id$
@ -128,7 +126,7 @@ and to C extension code as :c:data:`!Py_Py3kWarningFlag`.
The 3\ *xxx* series of PEPs, which contains proposals for Python 3.0. The 3\ *xxx* series of PEPs, which contains proposals for Python 3.0.
:pep:`3000` describes the development process for Python 3.0. :pep:`3000` describes the development process for Python 3.0.
Start with :pep:`3100` that describes the general goals for Python Start with :pep:`3100` that describes the general goals for Python
3.0, and then explore the higher-numbered PEPS that propose 3.0, and then explore the higher-numbered PEPs that propose
specific features. specific features.
@ -1051,8 +1049,6 @@ the :mod:`io` module:
sockets, but Python 2.6 hasn't restructured its file and socket objects sockets, but Python 2.6 hasn't restructured its file and socket objects
in this way. in this way.
.. XXX should 2.6 register them in io.py?
* :class:`BufferedIOBase` is an abstract base class that * :class:`BufferedIOBase` is an abstract base class that
buffers data in memory to reduce the number of buffers data in memory to reduce the number of
system calls used, making I/O processing more efficient. system calls used, making I/O processing more efficient.
@ -1133,8 +1129,6 @@ while an external caller could be modifying the contents,
so there's a corresponding ``PyBuffer_Release(Py_buffer *view)`` to so there's a corresponding ``PyBuffer_Release(Py_buffer *view)`` to
indicate that the external caller is done. indicate that the external caller is done.
.. XXX PyObject_GetBuffer not documented in c-api
The *flags* argument to :c:func:`PyObject_GetBuffer` specifies The *flags* argument to :c:func:`PyObject_GetBuffer` specifies
constraints upon the memory returned. Some examples are: constraints upon the memory returned. Some examples are:
@ -3110,8 +3104,8 @@ Port-Specific Changes: Windows
* The :mod:`msvcrt` module now supports * The :mod:`msvcrt` module now supports
both the normal and wide char variants of the console I/O both the normal and wide char variants of the console I/O
API. The :func:`getwch` function reads a keypress and returns a Unicode API. The :func:`~msvcrt.getwch` function reads a keypress and returns a Unicode
value, as does the :func:`getwche` function. The :func:`putwch` function value, as does the :func:`~msvcrt.getwche` function. The :func:`~msvcrt.putwch` function
takes a Unicode character and writes it to the console. takes a Unicode character and writes it to the console.
(Contributed by Christian Heimes.) (Contributed by Christian Heimes.)
@ -3120,24 +3114,24 @@ Port-Specific Changes: Windows
directory path. (Contributed by Josiah Carlson; :issue:`957650`.) directory path. (Contributed by Josiah Carlson; :issue:`957650`.)
* The :mod:`socket` module's socket objects now have an * The :mod:`socket` module's socket objects now have an
:meth:`ioctl` method that provides a limited interface to the :meth:`~socket.socket.ioctl` method that provides a limited interface to the
:c:func:`WSAIoctl` system interface. :c:func:`WSAIoctl` system interface.
* The :mod:`_winreg` module now has a function, * The :mod:`_winreg <winreg>` module now has a function,
:func:`ExpandEnvironmentStrings`, :func:`~winreg.ExpandEnvironmentStrings`,
that expands environment variable references such as ``%NAME%`` that expands environment variable references such as ``%NAME%``
in an input string. The handle objects provided by this in an input string. The handle objects provided by this
module now support the context protocol, so they can be used module now support the context protocol, so they can be used
in :keyword:`with` statements. (Contributed by Christian Heimes.) in :keyword:`with` statements. (Contributed by Christian Heimes.)
:mod:`_winreg` also has better support for x64 systems, :mod:`_winreg <winreg>` also has better support for x64 systems,
exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`, exposing the :func:`~winreg.DisableReflectionKey`, :func:`~winreg.EnableReflectionKey`,
and :func:`QueryReflectionKey` functions, which enable and disable and :func:`~winreg.QueryReflectionKey` functions, which enable and disable
registry reflection for 32-bit processes running on 64-bit systems. registry reflection for 32-bit processes running on 64-bit systems.
(:issue:`1753245`) (:issue:`1753245`)
* The :mod:`!msilib` module's :class:`Record` object * The :mod:`!msilib` module's :class:`!Record` object
gained :meth:`GetInteger` and :meth:`GetString` methods that gained :meth:`!GetInteger` and :meth:`!GetString` methods that
return field values as an integer or a string. return field values as an integer or a string.
(Contributed by Floris Bruynooghe; :issue:`2125`.) (Contributed by Floris Bruynooghe; :issue:`2125`.)
@ -3151,49 +3145,49 @@ Port-Specific Changes: Mac OS X
:option:`!--with-framework-name=` option to the :option:`!--with-framework-name=` option to the
:program:`configure` script. :program:`configure` script.
* The :mod:`macfs` module has been removed. This in turn required the * The :mod:`!macfs` module has been removed. This in turn required the
:func:`macostools.touched` function to be removed because it depended on the :func:`!macostools.touched` function to be removed because it depended on the
:mod:`macfs` module. (:issue:`1490190`) :mod:`!macfs` module. (:issue:`1490190`)
* Many other Mac OS modules have been deprecated and will be removed in * Many other Mac OS modules have been deprecated and will be removed in
Python 3.0: Python 3.0:
:mod:`_builtinSuites`, :mod:`!_builtinSuites`,
:mod:`aepack`, :mod:`!aepack`,
:mod:`aetools`, :mod:`!aetools`,
:mod:`aetypes`, :mod:`!aetypes`,
:mod:`applesingle`, :mod:`!applesingle`,
:mod:`appletrawmain`, :mod:`!appletrawmain`,
:mod:`appletrunner`, :mod:`!appletrunner`,
:mod:`argvemulator`, :mod:`!argvemulator`,
:mod:`Audio_mac`, :mod:`!Audio_mac`,
:mod:`autoGIL`, :mod:`!autoGIL`,
:mod:`Carbon`, :mod:`!Carbon`,
:mod:`cfmfile`, :mod:`!cfmfile`,
:mod:`CodeWarrior`, :mod:`!CodeWarrior`,
:mod:`ColorPicker`, :mod:`!ColorPicker`,
:mod:`EasyDialogs`, :mod:`!EasyDialogs`,
:mod:`Explorer`, :mod:`!Explorer`,
:mod:`Finder`, :mod:`!Finder`,
:mod:`FrameWork`, :mod:`!FrameWork`,
:mod:`findertools`, :mod:`!findertools`,
:mod:`ic`, :mod:`!ic`,
:mod:`icglue`, :mod:`!icglue`,
:mod:`icopen`, :mod:`!icopen`,
:mod:`macerrors`, :mod:`!macerrors`,
:mod:`MacOS`, :mod:`!MacOS`,
:mod:`macfs`, :mod:`!macfs`,
:mod:`macostools`, :mod:`!macostools`,
:mod:`macresource`, :mod:`!macresource`,
:mod:`MiniAEFrame`, :mod:`!MiniAEFrame`,
:mod:`Nav`, :mod:`!Nav`,
:mod:`Netscape`, :mod:`!Netscape`,
:mod:`OSATerminology`, :mod:`!OSATerminology`,
:mod:`pimp`, :mod:`!pimp`,
:mod:`PixMapWrapper`, :mod:`!PixMapWrapper`,
:mod:`StdSuites`, :mod:`!StdSuites`,
:mod:`SystemEvents`, :mod:`!SystemEvents`,
:mod:`Terminal`, and :mod:`!Terminal`, and
:mod:`terminalcommand`. :mod:`!terminalcommand`.
.. ====================================================================== .. ======================================================================
@ -3202,29 +3196,29 @@ Port-Specific Changes: IRIX
A number of old IRIX-specific modules were deprecated and will A number of old IRIX-specific modules were deprecated and will
be removed in Python 3.0: be removed in Python 3.0:
:mod:`al` and :mod:`AL`, :mod:`!al` and :mod:`!AL`,
:mod:`cd`, :mod:`!cd`,
:mod:`cddb`, :mod:`!cddb`,
:mod:`cdplayer`, :mod:`!cdplayer`,
:mod:`CL` and :mod:`cl`, :mod:`!CL` and :mod:`!cl`,
:mod:`DEVICE`, :mod:`!DEVICE`,
:mod:`ERRNO`, :mod:`!ERRNO`,
:mod:`FILE`, :mod:`!FILE`,
:mod:`FL` and :mod:`fl`, :mod:`!FL` and :mod:`!fl`,
:mod:`flp`, :mod:`!flp`,
:mod:`fm`, :mod:`!fm`,
:mod:`GET`, :mod:`!GET`,
:mod:`GLWS`, :mod:`!GLWS`,
:mod:`GL` and :mod:`gl`, :mod:`!GL` and :mod:`!gl`,
:mod:`IN`, :mod:`!IN`,
:mod:`IOCTL`, :mod:`!IOCTL`,
:mod:`jpeg`, :mod:`!jpeg`,
:mod:`panelparser`, :mod:`!panelparser`,
:mod:`readcd`, :mod:`!readcd`,
:mod:`SV` and :mod:`sv`, :mod:`!SV` and :mod:`!sv`,
:mod:`torgb`, :mod:`!torgb`,
:mod:`videoreader`, and :mod:`!videoreader`, and
:mod:`WAIT`. :mod:`!WAIT`.
.. ====================================================================== .. ======================================================================