Commit e483f024 authored by Stéphane Wirtel's avatar Stéphane Wirtel Committed by Victor Stinner

bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)

parent ddb961d2
...@@ -60,7 +60,7 @@ The following functions provide locale-independent string to number conversions. ...@@ -60,7 +60,7 @@ The following functions provide locale-independent string to number conversions.
The conversion is independent of the current locale. The conversion is independent of the current locale.
If ``endptr`` is ``NULL``, convert the whole string. Raise If ``endptr`` is ``NULL``, convert the whole string. Raise
ValueError and return ``-1.0`` if the string is not a valid :exc:`ValueError` and return ``-1.0`` if the string is not a valid
representation of a floating-point number. representation of a floating-point number.
If endptr is not ``NULL``, convert as much of the string as If endptr is not ``NULL``, convert as much of the string as
......
...@@ -528,7 +528,7 @@ Some unacceptable solutions that have been proposed: ...@@ -528,7 +528,7 @@ Some unacceptable solutions that have been proposed:
mydict = {[1, 2]: '12'} mydict = {[1, 2]: '12'}
print(mydict[[1, 2]]) print(mydict[[1, 2]])
would raise a KeyError exception because the id of the ``[1, 2]`` used in the would raise a :exc:`KeyError` exception because the id of the ``[1, 2]`` used in the
second line differs from that in the first line. In other words, dictionary second line differs from that in the first line. In other words, dictionary
keys should be compared using ``==``, not using :keyword:`is`. keys should be compared using ``==``, not using :keyword:`is`.
......
...@@ -63,7 +63,7 @@ How can I execute arbitrary Python statements from C? ...@@ -63,7 +63,7 @@ How can I execute arbitrary Python statements from C?
The highest-level function to do this is :c:func:`PyRun_SimpleString` which takes The highest-level function to do this is :c:func:`PyRun_SimpleString` which takes
a single string argument to be executed in the context of the module a single string argument to be executed in the context of the module
``__main__`` and returns ``0`` for success and ``-1`` when an exception occurred ``__main__`` and returns ``0`` for success and ``-1`` when an exception occurred
(including ``SyntaxError``). If you want more control, use (including :exc:`SyntaxError`). If you want more control, use
:c:func:`PyRun_String`; see the source for :c:func:`PyRun_SimpleString` in :c:func:`PyRun_String`; see the source for :c:func:`PyRun_SimpleString` in
``Python/pythonrun.c``. ``Python/pythonrun.c``.
......
...@@ -200,7 +200,7 @@ Glossary ...@@ -200,7 +200,7 @@ Glossary
``int(3.15)`` converts the floating point number to the integer ``3``, but ``int(3.15)`` converts the floating point number to the integer ``3``, but
in ``3+4.5``, each argument is of a different type (one int, one float), in ``3+4.5``, each argument is of a different type (one int, one float),
and both must be converted to the same type before they can be added or it and both must be converted to the same type before they can be added or it
will raise a ``TypeError``. Without coercion, all arguments of even will raise a :exc:`TypeError`. Without coercion, all arguments of even
compatible types would have to be normalized to the same value by the compatible types would have to be normalized to the same value by the
programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``. programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
......
...@@ -401,11 +401,11 @@ However, there are a few differences that should be taken into account: ...@@ -401,11 +401,11 @@ However, there are a few differences that should be taken into account:
because default values cannot be deleted from the section (because technically because default values cannot be deleted from the section (because technically
they are not there). If they are overridden in the section, deleting causes they are not there). If they are overridden in the section, deleting causes
the default value to be visible again. Trying to delete a default value the default value to be visible again. Trying to delete a default value
causes a ``KeyError``. causes a :exc:`KeyError`.
* ``DEFAULTSECT`` cannot be removed from the parser: * ``DEFAULTSECT`` cannot be removed from the parser:
* trying to delete it raises ``ValueError``, * trying to delete it raises :exc:`ValueError`,
* ``parser.clear()`` leaves it intact, * ``parser.clear()`` leaves it intact,
......
...@@ -229,7 +229,7 @@ file paths. ...@@ -229,7 +229,7 @@ file paths.
file path. For example, if *path* is file path. For example, if *path* is
``/foo/bar/__pycache__/baz.cpython-32.pyc`` the returned path would be ``/foo/bar/__pycache__/baz.cpython-32.pyc`` the returned path would be
``/foo/bar/baz.py``. *path* need not exist, however if it does not conform ``/foo/bar/baz.py``. *path* need not exist, however if it does not conform
to :pep:`3147` format, a ``ValueError`` is raised. If to :pep:`3147` format, a :exc:`ValueError` is raised. If
:attr:`sys.implementation.cache_tag` is not defined, :attr:`sys.implementation.cache_tag` is not defined,
:exc:`NotImplementedError` is raised. :exc:`NotImplementedError` is raised.
......
...@@ -1407,7 +1407,7 @@ an :term:`importer`. ...@@ -1407,7 +1407,7 @@ an :term:`importer`.
file path. For example, if *path* is file path. For example, if *path* is
``/foo/bar/__pycache__/baz.cpython-32.pyc`` the returned path would be ``/foo/bar/__pycache__/baz.cpython-32.pyc`` the returned path would be
``/foo/bar/baz.py``. *path* need not exist, however if it does not conform ``/foo/bar/baz.py``. *path* need not exist, however if it does not conform
to :pep:`3147` or :pep:`488` format, a ``ValueError`` is raised. If to :pep:`3147` or :pep:`488` format, a :exc:`ValueError` is raised. If
:attr:`sys.implementation.cache_tag` is not defined, :attr:`sys.implementation.cache_tag` is not defined,
:exc:`NotImplementedError` is raised. :exc:`NotImplementedError` is raised.
......
...@@ -39,7 +39,7 @@ pipe). ...@@ -39,7 +39,7 @@ pipe).
All streams are careful about the type of data you give to them. For example All streams are careful about the type of data you give to them. For example
giving a :class:`str` object to the ``write()`` method of a binary stream giving a :class:`str` object to the ``write()`` method of a binary stream
will raise a ``TypeError``. So will giving a :class:`bytes` object to the will raise a :exc:`TypeError`. So will giving a :class:`bytes` object to the
``write()`` method of a text stream. ``write()`` method of a text stream.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
......
...@@ -325,7 +325,7 @@ the :mod:`glob` module.) ...@@ -325,7 +325,7 @@ the :mod:`glob` module.)
Normalize the case of a pathname. On Unix and Mac OS X, this returns the Normalize the case of a pathname. On Unix and Mac OS X, this returns the
path unchanged; on case-insensitive filesystems, it converts the path to path unchanged; on case-insensitive filesystems, it converts the path to
lowercase. On Windows, it also converts forward slashes to backward slashes. lowercase. On Windows, it also converts forward slashes to backward slashes.
Raise a TypeError if the type of *path* is not ``str`` or ``bytes`` (directly Raise a :exc:`TypeError` if the type of *path* is not ``str`` or ``bytes`` (directly
or indirectly through the :class:`os.PathLike` interface). or indirectly through the :class:`os.PathLike` interface).
.. versionchanged:: 3.6 .. versionchanged:: 3.6
......
...@@ -1941,7 +1941,7 @@ to speed up repeated connections from the same clients. ...@@ -1941,7 +1941,7 @@ to speed up repeated connections from the same clients.
.. note:: .. note::
With versions of OpenSSL older than 0.9.8m, it is only possible With versions of OpenSSL older than 0.9.8m, it is only possible
to set options, not to clear them. Attempting to clear an option to set options, not to clear them. Attempting to clear an option
(by resetting the corresponding bits) will raise a ``ValueError``. (by resetting the corresponding bits) will raise a :exc:`ValueError`.
.. versionchanged:: 3.6 .. versionchanged:: 3.6
:attr:`SSLContext.options` returns :class:`Options` flags: :attr:`SSLContext.options` returns :class:`Options` flags:
......
...@@ -899,7 +899,7 @@ The module defines the following classes, functions and decorators: ...@@ -899,7 +899,7 @@ The module defines the following classes, functions and decorators:
non-``@overload``-decorated definition, while the latter is used at non-``@overload``-decorated definition, while the latter is used at
runtime but should be ignored by a type checker. At runtime, calling runtime but should be ignored by a type checker. At runtime, calling
a ``@overload``-decorated function directly will raise a ``@overload``-decorated function directly will raise
``NotImplementedError``. An example of overload that gives a more :exc:`NotImplementedError`. An example of overload that gives a more
precise type than can be expressed using a union or a type variable:: precise type than can be expressed using a union or a type variable::
@overload @overload
......
...@@ -1161,7 +1161,7 @@ Test cases ...@@ -1161,7 +1161,7 @@ Test cases
If *delta* is supplied instead of *places* then the difference If *delta* is supplied instead of *places* then the difference
between *first* and *second* must be less or equal to (or greater than) *delta*. between *first* and *second* must be less or equal to (or greater than) *delta*.
Supplying both *delta* and *places* raises a ``TypeError``. Supplying both *delta* and *places* raises a :exc:`TypeError`.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
:meth:`assertAlmostEqual` automatically considers almost equal objects :meth:`assertAlmostEqual` automatically considers almost equal objects
......
...@@ -41,7 +41,7 @@ objects: ...@@ -41,7 +41,7 @@ objects:
:noindex: :noindex:
Remove the first item from the list whose value is equal to *x*. It raises a Remove the first item from the list whose value is equal to *x*. It raises a
``ValueError`` if there is no such item. :exc:`ValueError` if there is no such item.
.. method:: list.pop([i]) .. method:: list.pop([i])
......
...@@ -593,7 +593,7 @@ a :term:`__future__` import is necessary:: ...@@ -593,7 +593,7 @@ a :term:`__future__` import is necessary::
RuntimeError: generator raised StopIteration RuntimeError: generator raised StopIteration
Without a ``__future__`` import, a :exc:`PendingDeprecationWarning` will be Without a ``__future__`` import, a :exc:`PendingDeprecationWarning` will be
raised whenever a ``StopIteration`` exception is raised inside a generator. raised whenever a :exc:`StopIteration` exception is raised inside a generator.
.. seealso:: .. seealso::
......
...@@ -741,7 +741,7 @@ Some smaller changes made to the core Python language are: ...@@ -741,7 +741,7 @@ Some smaller changes made to the core Python language are:
* A ``global`` or ``nonlocal`` statement must now textually appear * A ``global`` or ``nonlocal`` statement must now textually appear
before the first use of the affected name in the same scope. before the first use of the affected name in the same scope.
Previously this was a ``SyntaxWarning``. Previously this was a :exc:`SyntaxWarning`.
* It is now possible to set a :ref:`special method <specialnames>` to * It is now possible to set a :ref:`special method <specialnames>` to
``None`` to indicate that the corresponding operation is not available. ``None`` to indicate that the corresponding operation is not available.
......
...@@ -1030,7 +1030,7 @@ support the loading of resources from packages. See also ...@@ -1030,7 +1030,7 @@ support the loading of resources from packages. See also
lacks a spec. lacks a spec.
(Contributed by Garvit Khatri in :issue:`29851`.) (Contributed by Garvit Khatri in :issue:`29851`.)
:func:`importlib.find_spec` now raises ``ModuleNotFoundError`` instead of :func:`importlib.find_spec` now raises :exc:`ModuleNotFoundError` instead of
:exc:`AttributeError` if the specified parent module is not a package (i.e. :exc:`AttributeError` if the specified parent module is not a package (i.e.
lacks a ``__path__`` attribute). lacks a ``__path__`` attribute).
(Contributed by Milan Oberkirch in :issue:`30436`.) (Contributed by Milan Oberkirch in :issue:`30436`.)
......
Fix the documentation with the role ``exc`` for the appropriated exception. Patch by
Stéphane Wirtel
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment