Skip to content

gh-151947: Fix all Sphinx reference warnings in Doc/library/email.{charset,parser}.rst#151966

Open
lpyu001 wants to merge 2 commits into
python:mainfrom
lpyu001:fix-151941-in-email
Open

gh-151947: Fix all Sphinx reference warnings in Doc/library/email.{charset,parser}.rst#151966
lpyu001 wants to merge 2 commits into
python:mainfrom
lpyu001:fix-151941-in-email

Conversation

@lpyu001

@lpyu001 lpyu001 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

@read-the-docs-community

read-the-docs-community Bot commented Jun 23, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33264608 | 📁 Comparing be1878b against main (868d9a8)

  🔍 Preview build  

1 file changed
± library/email.charset.html

more information on what else *policy* controls, see the
:mod:`~email.policy` documentation.

Note: **The policy keyword should always be specified**; The default will

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note: **The policy keyword should always be specified**. The default will

Conversions will proceed from input charset, to Unicode, to the output charset
when the method :meth:`Charset.convert` is called. The default is to output in
the same character set as the input.
when the method :meth:`!Charset.convert` is called. The default is to output

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is masking a real bug. We can replace it with a reference to Charset.body_encode. You'll also have to make the same change to the docstring:

in. Conversions will proceed from input charset, to Unicode, to the
output charset when the method Charset.convert() is called. The default
is to output in the same character set as the input.

@StanFromIreland StanFromIreland changed the title gh-151947:Fix all Sphinx reference warnings in Doc/library/email.{charset,parser}.rst gh-151947: Fix all Sphinx reference warnings in Doc/library/email.{charset,parser}.rst Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants