GH-97950: Use new-style index directive ('statement') (#104162)

This commit is contained in:
Adam Turner 2023-05-04 11:48:45 +01:00 committed by GitHub
parent 3e7995ca11
commit 55d50d147c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 53 additions and 53 deletions

View file

@ -4,8 +4,8 @@ Built-in Exceptions
=================== ===================
.. index:: .. index::
statement: try pair: statement; try
statement: except pair: statement; except
In Python, all exceptions must be instances of a class that derives from In Python, all exceptions must be instances of a class that derives from
:class:`BaseException`. In a :keyword:`try` statement with an :keyword:`except` :class:`BaseException`. In a :keyword:`try` statement with an :keyword:`except`
@ -14,7 +14,7 @@ classes derived from that class (but not exception classes from which *it* is
derived). Two exception classes that are not related via subclassing are never derived). Two exception classes that are not related via subclassing are never
equivalent, even if they have the same name. equivalent, even if they have the same name.
.. index:: statement: raise .. index:: pair: statement; raise
The built-in exceptions listed below can be generated by the interpreter or The built-in exceptions listed below can be generated by the interpreter or
built-in functions. Except where mentioned, they have an "associated value" built-in functions. Except where mentioned, they have an "associated value"
@ -175,7 +175,7 @@ The following exceptions are the exceptions that are usually raised.
.. exception:: AssertionError .. exception:: AssertionError
.. index:: statement: assert .. index:: pair: statement; assert
Raised when an :keyword:`assert` statement fails. Raised when an :keyword:`assert` statement fails.

View file

@ -1986,7 +1986,7 @@ are always available. They are listed here in alphabetical order.
.. function:: __import__(name, globals=None, locals=None, fromlist=(), level=0) .. function:: __import__(name, globals=None, locals=None, fromlist=(), level=0)
.. index:: .. index::
statement: import pair: statement; import
pair: module; builtins pair: module; builtins
.. note:: .. note::

View file

@ -51,7 +51,7 @@ searched for site-packages; otherwise they will.
.. index:: .. index::
single: # (hash); comment single: # (hash); comment
statement: import pair: statement; import
A path configuration file is a file whose name has the form :file:`{name}.pth` A path configuration file is a file whose name has the form :file:`{name}.pth`
and exists in one of the four directories mentioned above; its contents are and exists in one of the four directories mentioned above; its contents are

View file

@ -32,8 +32,8 @@ Truth Value Testing
=================== ===================
.. index:: .. index::
statement: if pair: statement; if
statement: while pair: statement; while
pair: truth; value pair: truth; value
pair: Boolean; operations pair: Boolean; operations
single: false single: false
@ -1152,7 +1152,7 @@ accepts integers that meet the value restriction ``0 <= x <= 255``).
triple: operations on; list; type triple: operations on; list; type
pair: subscript; assignment pair: subscript; assignment
pair: slice; assignment pair: slice; assignment
statement: del pair: statement; del
single: append() (sequence method) single: append() (sequence method)
single: clear() (sequence method) single: clear() (sequence method)
single: copy() (sequence method) single: copy() (sequence method)
@ -4418,7 +4418,7 @@ Mapping Types --- :class:`dict`
pair: object; dictionary pair: object; dictionary
triple: operations on; mapping; types triple: operations on; mapping; types
triple: operations on; dictionary; type triple: operations on; dictionary; type
statement: del pair: statement; del
builtin: len builtin: len
A :term:`mapping` object maps :term:`hashable` values to arbitrary objects. A :term:`mapping` object maps :term:`hashable` values to arbitrary objects.

View file

@ -84,7 +84,7 @@ The :keyword:`!if` statement
============================ ============================
.. index:: .. index::
! statement: if ! pair: statement; if
pair: keyword; elif pair: keyword; elif
pair: keyword; else pair: keyword; else
single: : (colon); compound statement single: : (colon); compound statement
@ -109,7 +109,7 @@ The :keyword:`!while` statement
=============================== ===============================
.. index:: .. index::
! statement: while ! pair: statement; while
pair: keyword; else pair: keyword; else
pair: loop; statement pair: loop; statement
single: : (colon); compound statement single: : (colon); compound statement
@ -127,8 +127,8 @@ suite of the :keyword:`!else` clause, if present, is executed and the loop
terminates. terminates.
.. index:: .. index::
statement: break pair: statement; break
statement: continue pair: statement; continue
A :keyword:`break` statement executed in the first suite terminates the loop A :keyword:`break` statement executed in the first suite terminates the loop
without executing the :keyword:`!else` clause's suite. A :keyword:`continue` without executing the :keyword:`!else` clause's suite. A :keyword:`continue`
@ -142,7 +142,7 @@ The :keyword:`!for` statement
============================= =============================
.. index:: .. index::
! statement: for ! pair: statement; for
pair: keyword; in pair: keyword; in
pair: keyword; else pair: keyword; else
pair: target; list pair: target; list
@ -167,8 +167,8 @@ the suite in the :keyword:`!else` clause,
if present, is executed, and the loop terminates. if present, is executed, and the loop terminates.
.. index:: .. index::
statement: break pair: statement; break
statement: continue pair: statement; continue
A :keyword:`break` statement executed in the first suite terminates the loop A :keyword:`break` statement executed in the first suite terminates the loop
without executing the :keyword:`!else` clause's suite. A :keyword:`continue` without executing the :keyword:`!else` clause's suite. A :keyword:`continue`
@ -205,7 +205,7 @@ The :keyword:`!try` statement
============================= =============================
.. index:: .. index::
! statement: try ! pair: statement; try
pair: keyword; except pair: keyword; except
pair: keyword; finally pair: keyword; finally
pair: keyword; else pair: keyword; else
@ -388,9 +388,9 @@ cannot appear in an :keyword:`!except*` clause.
.. index:: .. index::
pair: keyword; else pair: keyword; else
statement: return pair: statement; return
statement: break pair: statement; break
statement: continue pair: statement; continue
.. _except_else: .. _except_else:
@ -434,9 +434,9 @@ The exception information is not available to the program during execution of
the :keyword:`!finally` clause. the :keyword:`!finally` clause.
.. index:: .. index::
statement: return pair: statement; return
statement: break pair: statement; break
statement: continue pair: statement; continue
When a :keyword:`return`, :keyword:`break` or :keyword:`continue` statement is When a :keyword:`return`, :keyword:`break` or :keyword:`continue` statement is
executed in the :keyword:`try` suite of a :keyword:`!try`...\ :keyword:`!finally` executed in the :keyword:`try` suite of a :keyword:`!try`...\ :keyword:`!finally`
@ -468,7 +468,7 @@ The :keyword:`!with` statement
============================== ==============================
.. index:: .. index::
! statement: with ! pair: statement; with
pair: keyword; as pair: keyword; as
single: as; with statement single: as; with statement
single: , (comma); with statement single: , (comma); with statement
@ -585,7 +585,7 @@ The :keyword:`!match` statement
=============================== ===============================
.. index:: .. index::
! statement: match ! pair: statement; match
! pair: keyword; case ! pair: keyword; case
! single: pattern matching ! single: pattern matching
pair: keyword; if pair: keyword; if
@ -1190,7 +1190,7 @@ Function definitions
==================== ====================
.. index:: .. index::
statement: def pair: statement; def
pair: function; definition pair: function; definition
pair: function; name pair: function; name
pair: name; binding pair: name; binding
@ -1364,7 +1364,7 @@ Class definitions
.. index:: .. index::
pair: object; class pair: object; class
statement: class pair: statement; class
pair: class; definition pair: class; definition
pair: class; name pair: class; name
pair: name; binding pair: name; binding
@ -1463,7 +1463,7 @@ Coroutines
.. versionadded:: 3.5 .. versionadded:: 3.5
.. index:: statement: async def .. index:: pair: statement; async def
.. _`async def`: .. _`async def`:
Coroutine function definition Coroutine function definition
@ -1497,7 +1497,7 @@ An example of a coroutine function::
``await`` and ``async`` are now keywords; previously they were only ``await`` and ``async`` are now keywords; previously they were only
treated as such inside the body of a coroutine function. treated as such inside the body of a coroutine function.
.. index:: statement: async for .. index:: pair: statement; async for
.. _`async for`: .. _`async for`:
The :keyword:`!async for` statement The :keyword:`!async for` statement
@ -1542,7 +1542,7 @@ It is a :exc:`SyntaxError` to use an ``async for`` statement outside the
body of a coroutine function. body of a coroutine function.
.. index:: statement: async with .. index:: pair: statement; async with
.. _`async with`: .. _`async with`:
The :keyword:`!async with` statement The :keyword:`!async with` statement

View file

@ -727,7 +727,7 @@ Callable types
Modules Modules
.. index:: .. index::
statement: import pair: statement; import
pair: object; module pair: object; module
Modules are a basic organizational unit of Python code, and are created by Modules are a basic organizational unit of Python code, and are created by
@ -1151,7 +1151,7 @@ Internal types
single: tb_frame (traceback attribute) single: tb_frame (traceback attribute)
single: tb_lineno (traceback attribute) single: tb_lineno (traceback attribute)
single: tb_lasti (traceback attribute) single: tb_lasti (traceback attribute)
statement: try pair: statement; try
Special read-only attributes: Special read-only attributes:
:attr:`tb_frame` points to the execution frame of the current level; :attr:`tb_frame` points to the execution frame of the current level;
@ -1310,7 +1310,7 @@ Basic customization
.. index:: .. index::
single: destructor single: destructor
single: finalizer single: finalizer
statement: del pair: statement; del
Called when the instance is about to be destroyed. This is also called a Called when the instance is about to be destroyed. This is also called a
finalizer or (improperly) a destructor. If a base class has a finalizer or (improperly) a destructor. If a base class has a
@ -2796,7 +2796,7 @@ execution of the block of code. Context managers are normally invoked using the
used by directly invoking their methods. used by directly invoking their methods.
.. index:: .. index::
statement: with pair: statement; with
single: context manager single: context manager
Typical uses of context managers include saving and restoring various kinds of Typical uses of context managers include saving and restoring various kinds of

View file

@ -376,7 +376,7 @@ The :keyword:`!assert` statement
================================ ================================
.. index:: .. index::
! statement: assert ! pair: statement; assert
pair: debugging; assertions pair: debugging; assertions
single: , (comma); expression list single: , (comma); expression list
@ -419,7 +419,7 @@ The :keyword:`!pass` statement
============================== ==============================
.. index:: .. index::
statement: pass pair: statement; pass
pair: null; operation pair: null; operation
pair: null; operation pair: null; operation
@ -441,7 +441,7 @@ The :keyword:`!del` statement
============================= =============================
.. index:: .. index::
! statement: del ! pair: statement; del
pair: deletion; target pair: deletion; target
triple: deletion; target; list triple: deletion; target; list
@ -454,7 +454,7 @@ Rather than spelling it out in full details, here are some hints.
Deletion of a target list recursively deletes each target, from left to right. Deletion of a target list recursively deletes each target, from left to right.
.. index:: .. index::
statement: global pair: statement; global
pair: unbinding; name pair: unbinding; name
Deletion of a name removes the binding of that name from the local or global Deletion of a name removes the binding of that name from the local or global
@ -480,7 +480,7 @@ The :keyword:`!return` statement
================================ ================================
.. index:: .. index::
! statement: return ! pair: statement; return
pair: function; definition pair: function; definition
pair: class; definition pair: class; definition
@ -517,7 +517,7 @@ The :keyword:`!yield` statement
=============================== ===============================
.. index:: .. index::
statement: yield pair: statement; yield
single: generator; function single: generator; function
single: generator; iterator single: generator; iterator
single: function; generator single: function; generator
@ -553,7 +553,7 @@ The :keyword:`!raise` statement
=============================== ===============================
.. index:: .. index::
! statement: raise ! pair: statement; raise
single: exception single: exception
pair: raising; exception pair: raising; exception
single: __traceback__ (exception attribute) single: __traceback__ (exception attribute)
@ -667,9 +667,9 @@ The :keyword:`!break` statement
=============================== ===============================
.. index:: .. index::
! statement: break ! pair: statement; break
statement: for pair: statement; for
statement: while pair: statement; while
pair: loop; statement pair: loop; statement
.. productionlist:: python-grammar .. productionlist:: python-grammar
@ -701,9 +701,9 @@ The :keyword:`!continue` statement
================================== ==================================
.. index:: .. index::
! statement: continue ! pair: statement; continue
statement: for pair: statement; for
statement: while pair: statement; while
pair: loop; statement pair: loop; statement
pair: keyword; finally pair: keyword; finally
@ -726,7 +726,7 @@ The :keyword:`!import` statement
================================ ================================
.. index:: .. index::
! statement: import ! pair: statement; import
single: module; importing single: module; importing
pair: name; binding pair: name; binding
pair: keyword; from pair: keyword; from
@ -942,7 +942,7 @@ The :keyword:`!global` statement
================================ ================================
.. index:: .. index::
! statement: global ! pair: statement; global
triple: global; name; binding triple: global; name; binding
single: , (comma); identifier list single: , (comma); identifier list
@ -988,7 +988,7 @@ call. The same applies to the :func:`eval` and :func:`compile` functions.
The :keyword:`!nonlocal` statement The :keyword:`!nonlocal` statement
================================== ==================================
.. index:: statement: nonlocal .. index:: pair: statement; nonlocal
single: , (comma); identifier list single: , (comma); identifier list
.. productionlist:: python-grammar .. productionlist:: python-grammar

View file

@ -694,7 +694,7 @@ def patch_pairindextypes(app) -> None:
pairindextypes.pop('operator', None) pairindextypes.pop('operator', None)
pairindextypes.pop('object', None) pairindextypes.pop('object', None)
pairindextypes.pop('exception', None) pairindextypes.pop('exception', None)
# pairindextypes.pop('statement', None) pairindextypes.pop('statement', None)
# pairindextypes.pop('builtin', None) # pairindextypes.pop('builtin', None)

View file

@ -46,7 +46,7 @@ details see :ref:`tut-match`.
========================== ==========================
.. index:: .. index::
statement: for pair: statement; for
The :keyword:`for` statement in Python differs a bit from what you may be used The :keyword:`for` statement in Python differs a bit from what you may be used
to in C or Pascal. Rather than always iterating over an arithmetic progression to in C or Pascal. Rather than always iterating over an arithmetic progression