Skip to content

GH-97950: Use new-style index directive ('exception') #104160

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.

Sign up for GitHub

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 2 commits into from
May 4, 2023
Merged

GH-97950: Use new-style index directive ('exception') #104160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
397fa10
Uncomment exception removal in pairindextypes
AA-Turner May 4, 2023
6f0979c
Use new-style index directive ('exception') - Reference
AA-Turner May 4, 2023
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
18 changes: 9 additions & 9 deletions Doc/reference/expressions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ An identifier occurring as an atom is a name. See section :ref:`identifiers`
for lexical definition and section :ref:`naming` for documentation of naming and
binding.

.. index:: exception: NameError
.. index:: pair: exception; NameError

When the name is bound to an object, evaluation of the atom yields that object.
When a name is not bound, an attempt to evaluate it raises a :exc:`NameError`
Expand Down Expand Up @@ -534,7 +534,7 @@ be used to control the execution of a generator function.
Note that calling any of the generator methods below when the generator
is already executing raises a :exc:`ValueError` exception.

.. index:: exception: StopIteration
.. index:: pair: exception; StopIteration


.. method:: generator.__next__()
Expand Down Expand Up @@ -589,7 +589,7 @@ is already executing raises a :exc:`ValueError` exception.
The second signature \(type\[, value\[, traceback\]\]\) is deprecated and
may be removed in a future version of Python.

.. index:: exception: GeneratorExit
.. index:: pair: exception; GeneratorExit


.. method:: generator.close()
Expand Down Expand Up @@ -711,7 +711,7 @@ This subsection describes the methods of an asynchronous generator iterator,
which are used to control the execution of a generator function.


.. index:: exception: StopAsyncIteration
.. index:: pair: exception; StopAsyncIteration

.. coroutinemethod:: agen.__anext__()

Expand Down Expand Up @@ -763,7 +763,7 @@ which are used to control the execution of a generator function.
The second signature \(type\[, value\[, traceback\]\]\) is deprecated and
may be removed in a future version of Python.

.. index:: exception: GeneratorExit
.. index:: pair: exception; GeneratorExit


.. coroutinemethod:: agen.aclose()
Expand Down Expand Up @@ -810,7 +810,7 @@ An attribute reference is a primary followed by a period and a name:
attributeref: `primary` "." `identifier`

.. index::
exception: AttributeError
pair: exception; AttributeError
pair: object; module
pair: object; list

Expand Down Expand Up @@ -1241,7 +1241,7 @@ applies to integral numbers or to custom objects that override the



.. index:: exception: TypeError
.. index:: pair: exception; TypeError

In all three cases, if the argument does not have the proper type, a
:exc:`TypeError` exception is raised.
Expand Down Expand Up @@ -1288,7 +1288,7 @@ builtin Python types implement this operator.
.. versionadded:: 3.5

.. index::
exception: ZeroDivisionError
pair: exception; ZeroDivisionError
single: division
pair: operator; / (slash)
pair: operator; //
Expand Down Expand Up @@ -1377,7 +1377,7 @@ the left or right by the number of bits given by the second argument.
This operation can be customized using the special :meth:`__lshift__` and
:meth:`__rshift__` methods.

.. index:: exception: ValueError
.. index:: pair: exception; ValueError

A right shift by *n* bits is defined as floor division by ``pow(2,n)``. A left
shift by *n* bits is defined as multiplication with ``pow(2,n)``.
Expand Down
6 changes: 3 additions & 3 deletions Doc/reference/simple_stmts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ The extended form, ``assert expression1, expression2``, is equivalent to ::

.. index::
single: __debug__
exception: AssertionError
pair: exception; AssertionError

These equivalences assume that :const:`__debug__` and :exc:`AssertionError` refer to
the built-in variables with those names. In the current implementation, the
Expand Down Expand Up @@ -521,7 +521,7 @@ The :keyword:`!yield` statement
single: generator; function
single: generator; iterator
single: function; generator
exception: StopIteration
pair: exception; StopIteration

.. productionlist:: python-grammar
yield_stmt: `yield_expression`
Expand Down Expand Up @@ -731,7 +731,7 @@ The :keyword:`!import` statement
pair: name; binding
pair: keyword; from
pair: keyword; as
exception: ImportError
pair: exception; ImportError
single: , (comma); import statement

.. productionlist:: python-grammar
Expand Down
2 changes: 1 addition & 1 deletion Doc/tools/extensions/pyspecific.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ def patch_pairindextypes(app) -> None:
pairindextypes.pop('keyword', None)
pairindextypes.pop('operator', None)
pairindextypes.pop('object', None)
# pairindextypes.pop('exception', None)
pairindextypes.pop('exception', None)
# pairindextypes.pop('statement', None)
# pairindextypes.pop('builtin', None)

Expand Down