Skip to content

GH-97950: Use new-style index directive ('keyword') #104153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions Doc/reference/compound_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ The :keyword:`!if` statement

.. index::
! statement: if
keyword: elif
keyword: else
pair: keyword; elif
pair: keyword; else
single: : (colon); compound statement

The :keyword:`if` statement is used for conditional execution:
Expand All @@ -110,7 +110,7 @@ The :keyword:`!while` statement

.. index::
! statement: while
keyword: else
pair: keyword; else
pair: loop; statement
single: : (colon); compound statement

Expand Down Expand Up @@ -143,8 +143,8 @@ The :keyword:`!for` statement

.. index::
! statement: for
keyword: in
keyword: else
pair: keyword; in
pair: keyword; else
pair: target; list
pair: loop; statement
object: sequence
Expand Down Expand Up @@ -206,10 +206,10 @@ The :keyword:`!try` statement

.. index::
! statement: try
keyword: except
keyword: finally
keyword: else
keyword: as
pair: keyword; except
pair: keyword; finally
pair: keyword; else
pair: keyword; as
single: : (colon); compound statement

The :keyword:`!try` statement specifies exception handlers and/or cleanup code
Expand Down Expand Up @@ -326,7 +326,7 @@ stored in the :mod:`sys` module is reset to its previous value::


.. index::
keyword: except_star
pair: keyword; except_star

.. _except_star:

Expand Down Expand Up @@ -387,7 +387,7 @@ cannot appear in an :keyword:`!except*` clause.


.. index::
keyword: else
pair: keyword; else
statement: return
statement: break
statement: continue
Expand All @@ -404,7 +404,7 @@ the :keyword:`!else` clause are not handled by the preceding :keyword:`except`
clauses.


.. index:: keyword: finally
.. index:: pair: keyword; finally

.. _finally:

Expand Down Expand Up @@ -469,7 +469,7 @@ The :keyword:`!with` statement

.. index::
! statement: with
keyword: as
pair: keyword; as
single: as; with statement
single: , (comma); with statement
single: : (colon); compound statement
Expand Down Expand Up @@ -586,10 +586,10 @@ The :keyword:`!match` statement

.. index::
! statement: match
! keyword: case
! pair: keyword; case
! single: pattern matching
keyword: if
keyword: as
pair: keyword; if
pair: keyword; as
pair: match; case
single: as; match statement
single: : (colon); compound statement
Expand Down Expand Up @@ -1474,8 +1474,8 @@ Coroutine function definition
: ["->" `expression`] ":" `suite`

.. index::
keyword: async
keyword: await
pair: keyword; async
pair: keyword; await

Execution of Python coroutines can be suspended and resumed at many points
(see :term:`coroutine`). :keyword:`await` expressions, :keyword:`async for` and
Expand Down
6 changes: 3 additions & 3 deletions Doc/reference/expressions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -415,8 +415,8 @@ Yield expressions
-----------------

.. index::
keyword: yield
keyword: from
pair: keyword; yield
pair: keyword; from
pair: yield; expression
pair: generator; function

Expand Down Expand Up @@ -1149,7 +1149,7 @@ a class instance:
if that method was called.


.. index:: keyword: await
.. index:: pair: keyword; await
.. _await:

Await expression
Expand Down
12 changes: 6 additions & 6 deletions Doc/reference/simple_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ If an expression list is present, it is evaluated, else ``None`` is substituted.
:keyword:`return` leaves the current function call with the expression list (or
``None``) as return value.

.. index:: keyword: finally
.. index:: pair: keyword; finally

When :keyword:`return` passes control out of a :keyword:`try` statement with a
:keyword:`finally` clause, that :keyword:`!finally` clause is executed before
Expand Down Expand Up @@ -679,7 +679,7 @@ The :keyword:`!break` statement
:keyword:`while` loop, but not nested in a function or class definition within
that loop.

.. index:: keyword: else
.. index:: pair: keyword; else
pair: loop control; target

It terminates the nearest enclosing loop, skipping the optional :keyword:`!else`
Expand All @@ -688,7 +688,7 @@ clause if the loop has one.
If a :keyword:`for` loop is terminated by :keyword:`break`, the loop control
target keeps its current value.

.. index:: keyword: finally
.. index:: pair: keyword; finally

When :keyword:`break` passes control out of a :keyword:`try` statement with a
:keyword:`finally` clause, that :keyword:`!finally` clause is executed before
Expand All @@ -705,7 +705,7 @@ The :keyword:`!continue` statement
statement: for
statement: while
pair: loop; statement
keyword: finally
pair: keyword; finally

.. productionlist:: python-grammar
continue_stmt: "continue"
Expand All @@ -729,8 +729,8 @@ The :keyword:`!import` statement
! statement: import
single: module; importing
pair: name; binding
keyword: from
keyword: as
pair: keyword; from
pair: keyword; as
exception: ImportError
single: , (comma); import statement

Expand Down
2 changes: 1 addition & 1 deletion Doc/tools/extensions/pyspecific.py
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ def patch_pairindextypes(app) -> None:
# exist, by deleting them when using the gettext builder.

pairindextypes.pop('module', None)
# pairindextypes.pop('keyword', None)
pairindextypes.pop('keyword', None)
# pairindextypes.pop('operator', None)
# pairindextypes.pop('object', None)
# pairindextypes.pop('exception', None)
Expand Down