Skip to content

Commit 93927e9

Browse files
AA-Turnerlkollar
authored andcommitted
pythonGH-101100: Resolve reference warnings in whatsnew/3.3.rst (python#138414)
1 parent f3ce079 commit 93927e9

File tree

3 files changed

+42
-42
lines changed

3 files changed

+42
-42
lines changed

Doc/library/curses.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -716,8 +716,10 @@ The module :mod:`curses` defines the following functions:
716716
Window Objects
717717
--------------
718718

719-
Window objects, as returned by :func:`initscr` and :func:`newwin` above, have
720-
the following methods and attributes:
719+
.. class:: window
720+
721+
Window objects, as returned by :func:`initscr` and :func:`newwin` above, have
722+
the following methods and attributes:
721723

722724

723725
.. method:: window.addch(ch[, attr])

Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ Doc/whatsnew/2.4.rst
6262
Doc/whatsnew/2.5.rst
6363
Doc/whatsnew/2.6.rst
6464
Doc/whatsnew/2.7.rst
65-
Doc/whatsnew/3.3.rst
6665
Doc/whatsnew/3.4.rst
6766
Doc/whatsnew/3.5.rst
6867
Doc/whatsnew/3.6.rst

Doc/whatsnew/3.3.rst

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ simplified and finer-grained.
331331

332332
You don't have to worry anymore about choosing the appropriate exception
333333
type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`,
334-
:exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or
334+
:exc:`WindowsError`, :exc:`!mmap.error`, :exc:`socket.error` or
335335
:exc:`select.error`. All these exception types are now only one:
336336
:exc:`OSError`. The other names are kept as aliases for compatibility
337337
reasons.
@@ -805,7 +805,7 @@ Some smaller changes made to the core Python language are:
805805
* New methods have been added to :class:`list` and :class:`bytearray`:
806806
``copy()`` and ``clear()`` (:issue:`10516`). Consequently,
807807
:class:`~collections.abc.MutableSequence` now also defines a
808-
:meth:`~collections.abc.MutableSequence.clear` method (:issue:`11388`).
808+
:meth:`!clear` method (:issue:`11388`).
809809

810810
* Raw bytes literals can now be written ``rb"..."`` as well as ``br"..."``.
811811

@@ -869,10 +869,10 @@ faulthandler
869869
This new debug module :mod:`faulthandler` contains functions to dump Python tracebacks explicitly,
870870
on a fault (a crash like a segmentation fault), after a timeout, or on a user
871871
signal. Call :func:`faulthandler.enable` to install fault handlers for the
872-
:const:`SIGSEGV`, :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS`, and
873-
:const:`SIGILL` signals. You can also enable them at startup by setting the
874-
:envvar:`PYTHONFAULTHANDLER` environment variable or by using :option:`-X`
875-
``faulthandler`` command line option.
872+
:const:`~signal.SIGSEGV`, :const:`~signal.SIGFPE`, :const:`~signal.SIGABRT`,
873+
:const:`~signal.SIGBUS`, and :const:`~signal.SIGILL` signals.
874+
You can also enable them at startup by setting the :envvar:`PYTHONFAULTHANDLER`
875+
environment variable or by using :option:`-X` ``faulthandler`` command line option.
876876

877877
Example of a segmentation fault on Linux:
878878

@@ -916,7 +916,7 @@ abc
916916

917917
Improved support for abstract base classes containing descriptors composed with
918918
abstract methods. The recommended approach to declaring abstract descriptors is
919-
now to provide :attr:`__isabstractmethod__` as a dynamically updated
919+
now to provide :attr:`!__isabstractmethod__` as a dynamically updated
920920
property. The built-in descriptors have been updated accordingly.
921921

922922
* :class:`abc.abstractproperty` has been deprecated, use :class:`property`
@@ -979,7 +979,7 @@ new features have been added:
979979
(Contributed by Nir Aides in :issue:`1625`.)
980980

981981
* :class:`bz2.BZ2File` now implements all of the :class:`io.BufferedIOBase` API,
982-
except for the :meth:`detach` and :meth:`truncate` methods.
982+
except for the :meth:`!detach` and :meth:`!truncate` methods.
983983

984984

985985
codecs
@@ -1064,7 +1064,7 @@ curses
10641064

10651065
* If the :mod:`curses` module is linked to the ncursesw library, use Unicode
10661066
functions when Unicode strings or characters are passed (e.g.
1067-
:c:func:`waddwstr`), and bytes functions otherwise (e.g. :c:func:`waddstr`).
1067+
:c:func:`!waddwstr`), and bytes functions otherwise (e.g. :c:func:`!waddstr`).
10681068
* Use the locale encoding instead of ``utf-8`` to encode Unicode strings.
10691069
* :class:`curses.window` has a new :attr:`curses.window.encoding` attribute.
10701070
* The :class:`curses.window` class has a new :meth:`~curses.window.get_wch`
@@ -1137,15 +1137,15 @@ API changes
11371137
* The C module has the following context limits, depending on the machine
11381138
architecture:
11391139

1140-
+-------------------+----------------+-------------------------+
1141-
| | 32-bit | 64-bit |
1142-
+===================+================+=========================+
1143-
| :const:`MAX_PREC` | ``425000000`` | ``999999999999999999`` |
1144-
+-------------------+----------------+-------------------------+
1145-
| :const:`MAX_EMAX` | ``425000000`` | ``999999999999999999`` |
1146-
+-------------------+----------------+-------------------------+
1147-
| :const:`MIN_EMIN` | ``-425000000`` | ``-999999999999999999`` |
1148-
+-------------------+----------------+-------------------------+
1140+
+----------------------------+----------------+-------------------------+
1141+
| | 32-bit | 64-bit |
1142+
+============================+================+=========================+
1143+
| :const:`~decimal.MAX_PREC` | ``425000000`` | ``999999999999999999`` |
1144+
+----------------------------+----------------+-------------------------+
1145+
| :const:`~decimal.MAX_EMAX` | ``425000000`` | ``999999999999999999`` |
1146+
+----------------------------+----------------+-------------------------+
1147+
| :const:`~decimal.MIN_EMIN` | ``-425000000`` | ``-999999999999999999`` |
1148+
+----------------------------+----------------+-------------------------+
11491149

11501150
* In the context templates (:const:`~decimal.DefaultContext`,
11511151
:const:`~decimal.BasicContext` and :const:`~decimal.ExtendedContext`)
@@ -1434,7 +1434,7 @@ html
14341434

14351435
:class:`html.parser.HTMLParser` is now able to parse broken markup without
14361436
raising errors, therefore the *strict* argument of the constructor and the
1437-
:exc:`~html.parser.HTMLParseError` exception are now deprecated.
1437+
:exc:`!HTMLParseError` exception are now deprecated.
14381438
The ability to parse broken markup is the result of a number of bug fixes that
14391439
are also available on the latest bug fix releases of Python 2.7/3.2.
14401440
(Contributed by Ezio Melotti in :issue:`15114`, and :issue:`14538`,
@@ -1486,7 +1486,7 @@ already exists. It is based on the C11 'x' mode to fopen().
14861486

14871487
The constructor of the :class:`~io.TextIOWrapper` class has a new
14881488
*write_through* optional argument. If *write_through* is ``True``, calls to
1489-
:meth:`~io.TextIOWrapper.write` are guaranteed not to be buffered: any data
1489+
:meth:`!write` are guaranteed not to be buffered: any data
14901490
written on the :class:`~io.TextIOWrapper` object is immediately handled to its
14911491
underlying binary buffer.
14921492

@@ -1504,7 +1504,7 @@ logging
15041504
The :func:`~logging.basicConfig` function now supports an optional ``handlers``
15051505
argument taking an iterable of handlers to be added to the root logger.
15061506

1507-
A class level attribute :attr:`~logging.handlers.SysLogHandler.append_nul` has
1507+
A class level attribute :attr:`!append_nul` has
15081508
been added to :class:`~logging.handlers.SysLogHandler` to allow control of the
15091509
appending of the ``NUL`` (``\000``) byte to syslog records, since for some
15101510
daemons it is required while for others it is passed through to the log.
@@ -1536,8 +1536,8 @@ The new :func:`multiprocessing.connection.wait` function allows polling
15361536
multiple objects (such as connections, sockets and pipes) with a timeout.
15371537
(Contributed by Richard Oudkerk in :issue:`12328`.)
15381538

1539-
:class:`multiprocessing.Connection` objects can now be transferred over
1540-
multiprocessing connections.
1539+
:class:`multiprocessing.connection.Connection` objects can now be transferred
1540+
over multiprocessing connections.
15411541
(Contributed by Richard Oudkerk in :issue:`4892`.)
15421542

15431543
:class:`multiprocessing.Process` now accepts a ``daemon`` keyword argument
@@ -1611,7 +1611,7 @@ os
16111611
:func:`~os.rename`, :func:`~os.replace`, :func:`~os.rmdir`, :func:`~os.stat`,
16121612
:func:`~os.symlink`, :func:`~os.unlink`, :func:`~os.utime`. Platform
16131613
support for using these parameters can be checked via the sets
1614-
:data:`os.supports_dir_fd` and :data:`os.supports_follows_symlinks`.
1614+
:data:`os.supports_dir_fd` and :data:`os.supports_follow_symlinks`.
16151615

16161616
- The following functions now support a file descriptor for their path argument:
16171617
:func:`~os.chdir`, :func:`~os.chmod`, :func:`~os.chown`,
@@ -1698,7 +1698,7 @@ os
16981698
:const:`~os.RTLD_NOLOAD`, and :const:`~os.RTLD_DEEPBIND` are available on
16991699
platforms that support them. These are for use with the
17001700
:func:`sys.setdlopenflags` function, and supersede the similar constants
1701-
defined in :mod:`ctypes` and :mod:`DLFCN`. (Contributed by Victor Stinner
1701+
defined in :mod:`ctypes` and :mod:`!DLFCN`. (Contributed by Victor Stinner
17021702
in :issue:`13226`.)
17031703

17041704
* :func:`os.symlink` now accepts (and ignores) the ``target_is_directory``
@@ -1728,8 +1728,8 @@ reduction functions to be set.
17281728
pydoc
17291729
-----
17301730

1731-
The Tk GUI and the :func:`~pydoc.serve` function have been removed from the
1732-
:mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated
1731+
The Tk GUI and the :func:`!serve` function have been removed from the
1732+
:mod:`pydoc` module: ``pydoc -g`` and :func:`!serve` have been deprecated
17331733
in Python 3.2.
17341734

17351735

@@ -1931,7 +1931,7 @@ ssl
19311931

19321932
* :func:`~ssl.RAND_bytes`: generate cryptographically strong
19331933
pseudo-random bytes.
1934-
* :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes.
1934+
* :func:`!RAND_pseudo_bytes`: generate pseudo-random bytes.
19351935

19361936
(Contributed by Victor Stinner in :issue:`12049`.)
19371937

@@ -2020,8 +2020,7 @@ tarfile
20202020
tempfile
20212021
--------
20222022

2023-
:class:`tempfile.SpooledTemporaryFile`\'s
2024-
:meth:`~tempfile.SpooledTemporaryFile.truncate` method now accepts
2023+
:class:`tempfile.SpooledTemporaryFile`\'s :meth:`!truncate` method now accepts
20252024
a ``size`` parameter. (Contributed by Ryan Kelly in :issue:`9957`.)
20262025

20272026

@@ -2129,7 +2128,7 @@ xml.etree.ElementTree
21292128

21302129
The :mod:`xml.etree.ElementTree` module now imports its C accelerator by
21312130
default; there is no longer a need to explicitly import
2132-
:mod:`xml.etree.cElementTree` (this module stays for backwards compatibility,
2131+
:mod:`!xml.etree.cElementTree` (this module stays for backwards compatibility,
21332132
but is now deprecated). In addition, the ``iter`` family of methods of
21342133
:class:`~xml.etree.ElementTree.Element` has been optimized (rewritten in C).
21352134
The module's documentation has also been greatly improved with added examples
@@ -2197,7 +2196,7 @@ Changes to Python's build process and to the C API include:
21972196
* :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy`
21982197
* :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`,
21992198
:c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA`
2200-
* :c:macro:`PyUnicode_KIND` with :c:enum:`PyUnicode_Kind` enum:
2199+
* :c:macro:`PyUnicode_KIND` with :c:enum:`!PyUnicode_Kind` enum:
22012200
:c:data:`!PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`,
22022201
:c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND`
22032202
* :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE`
@@ -2232,17 +2231,17 @@ Deprecated Python modules, functions and methods
22322231
(``utf-32-le`` or ``utf-32-be``)
22332232
* :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use
22342233
:meth:`ftplib.FTP.mlsd`
2235-
* :func:`platform.popen`: use the :mod:`subprocess` module. Check especially
2234+
* :func:`!platform.popen`: use the :mod:`subprocess` module. Check especially
22362235
the :ref:`subprocess-replacements` section (:issue:`11377`).
22372236
* :issue:`13374`: The Windows bytes API has been deprecated in the :mod:`os`
22382237
module. Use Unicode filenames, instead of bytes filenames, to not depend on
22392238
the ANSI code page anymore and to support any filename.
2240-
* :issue:`13988`: The :mod:`xml.etree.cElementTree` module is deprecated. The
2239+
* :issue:`13988`: The :mod:`!xml.etree.cElementTree` module is deprecated. The
22412240
accelerator is used automatically whenever available.
2242-
* The behaviour of :func:`time.clock` depends on the platform: use the new
2241+
* The behaviour of :func:`!time.clock` depends on the platform: use the new
22432242
:func:`time.perf_counter` or :func:`time.process_time` function instead,
22442243
depending on your requirements, to have a well defined behaviour.
2245-
* The :func:`os.stat_float_times` function is deprecated.
2244+
* The :func:`!os.stat_float_times` function is deprecated.
22462245
* :mod:`abc` module:
22472246

22482247
* :class:`abc.abstractproperty` has been deprecated, use :class:`property`
@@ -2381,8 +2380,8 @@ Porting Python code
23812380
for top-level modules. E.g. ``__import__('sys', level=1)`` is now an error.
23822381

23832382
* Because :data:`sys.meta_path` and :data:`sys.path_hooks` now have finders on
2384-
them by default, you will most likely want to use :meth:`list.insert` instead
2385-
of :meth:`list.append` to add to those lists.
2383+
them by default, you will most likely want to use :meth:`!list.insert` instead
2384+
of :meth:`!list.append` to add to those lists.
23862385

23872386
* Because ``None`` is now inserted into :data:`sys.path_importer_cache`, if you
23882387
are clearing out entries in the dictionary of paths that do not have a
@@ -2466,7 +2465,7 @@ Porting C code
24662465
* In the course of changes to the buffer API the undocumented
24672466
:c:member:`!smalltable` member of the
24682467
:c:type:`Py_buffer` structure has been removed and the
2469-
layout of the :c:type:`PyMemoryViewObject` has changed.
2468+
layout of the :c:type:`!PyMemoryViewObject` has changed.
24702469

24712470
All extensions relying on the relevant parts in ``memoryobject.h``
24722471
or ``object.h`` must be rebuilt.

0 commit comments

Comments
 (0)