Skip to content

Commit

Permalink
Docs: fix MessageDefect references in email.policy docs (GH-128468)
Browse files Browse the repository at this point in the history
(cherry picked from commit 3b231be)

Co-authored-by: Yuki Kobayashi <[email protected]>
  • Loading branch information
koyuki7w authored and miss-islington committed Jan 5, 2025
1 parent d712ece commit 95cd530
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
4 changes: 2 additions & 2 deletions Doc/library/email.policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ added matters. To illustrate::

Handle a *defect* found on *obj*. When the email package calls this
method, *defect* will always be a subclass of
:class:`~email.errors.Defect`.
:class:`~email.errors.MessageDefect`.

The default implementation checks the :attr:`raise_on_defect` flag. If
it is ``True``, *defect* is raised as an exception. If it is ``False``
Expand All @@ -277,7 +277,7 @@ added matters. To illustrate::
.. method:: register_defect(obj, defect)

Register a *defect* on *obj*. In the email package, *defect* will always
be a subclass of :class:`~email.errors.Defect`.
be a subclass of :class:`~email.errors.MessageDefect`.

The default implementation calls the ``append`` method of the ``defects``
attribute of *obj*. When the email package calls :attr:`handle_defect`,
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst
Doc/library/email.errors.rst
Doc/library/email.parser.rst
Doc/library/email.policy.rst
Doc/library/exceptions.rst
Doc/library/functools.rst
Doc/library/getopt.rst
Expand Down

0 comments on commit 95cd530

Please sign in to comment.