[Python-checkins] GH-97950: Use new-style index directive ('keyword') (#104153)
ezio-melotti
webhook-mailer at python.org
Thu May 4 04:44:19 EDT 2023
https://github.com/python/cpython/commit/33ca322c50baa5152afe388fb3b8b7d63dc5a9b9
commit: 33ca322c50baa5152afe388fb3b8b7d63dc5a9b9
branch: main
author: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
committer: ezio-melotti <ezio.melotti at gmail.com>
date: 2023-05-04T10:44:12+02:00
summary:
GH-97950: Use new-style index directive ('keyword') (#104153)
* Uncomment keyword removal in pairindextypes
* Use new-style index directive ('keyword') - Reference
files:
M Doc/reference/compound_stmts.rst
M Doc/reference/expressions.rst
M Doc/reference/simple_stmts.rst
M Doc/tools/extensions/pyspecific.py
diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index 4bdecbf24365..1f03180f1565 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -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:
@@ -110,7 +110,7 @@ The :keyword:`!while` statement
.. index::
! statement: while
- keyword: else
+ pair: keyword; else
pair: loop; statement
single: : (colon); compound statement
@@ -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
@@ -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
@@ -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:
@@ -387,7 +387,7 @@ cannot appear in an :keyword:`!except*` clause.
.. index::
- keyword: else
+ pair: keyword; else
statement: return
statement: break
statement: continue
@@ -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:
@@ -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
@@ -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
@@ -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
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index 1e4a13fbd6a3..fe2b090b23c6 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -415,8 +415,8 @@ Yield expressions
-----------------
.. index::
- keyword: yield
- keyword: from
+ pair: keyword; yield
+ pair: keyword; from
pair: yield; expression
pair: generator; function
@@ -1149,7 +1149,7 @@ a class instance:
if that method was called.
-.. index:: keyword: await
+.. index:: pair: keyword; await
.. _await:
Await expression
diff --git a/Doc/reference/simple_stmts.rst b/Doc/reference/simple_stmts.rst
index c98ac81e415b..5c7b5d7efaa2 100644
--- a/Doc/reference/simple_stmts.rst
+++ b/Doc/reference/simple_stmts.rst
@@ -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
@@ -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`
@@ -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
@@ -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"
@@ -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
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 12d3e382c873..c347a327e091 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -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)
More information about the Python-checkins
mailing list