Skip to content

gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst #136323

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

Jump to bottom
Merged
merged 2 commits into from
Jul 7, 2025
Merged

gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst #136323

merged 2 commits into from
Jul 7, 2025

Conversation

LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Jul 5, 2025 •
edited
Loading

before:

C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:226: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:238: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:267: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:267: WARNING: py:meth reference target not found: email.emailmessage.EmailMessage.set_content [ref.meth]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:278: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:488: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:526: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]
C:\Users\admin\Downloads\cpython-main\Doc\library\email.compat32-message.rst:581: WARNING: py:class reference target not found: email.emailmessage.EmailMessage [ref.class]

The warnings are raised in a same reason. An example:

      This is a legacy method.  On the
      :class:`~email.emailmessage.EmailMessage` class its functionality is
      replaced by :meth:`~email.message.EmailMessage.get_content` and
      :meth:`~email.message.EmailMessage.iter_parts`.

image

The referrence to EmailMessage is invalid, because the moudle is actually email.message.EmailMessage not email.emailmessage.EmailMessage . This PR fix them all.

After:

image

and the example:

image

In this example, you can check the set_content method, which is a method of email.message.EmailMessage not email.emailmessage.EmailMessage

The preview doc of this moudle: https://cpython-previews--136323.org.readthedocs.build/en/136323/library/email.compat32-message.html?readthedocs-diff=true&readthedocs-diff-chunk=1

📚 Documentation preview 📚: https://cpython-previews--136323.org.readthedocs.build/

@LamentXU123 LamentXU123 requested review from a team, AA-Turner and hugovk as code owners July 5, 2025 18:28
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 5, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 5, 2025
Open
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 5, 2025
@hugovk hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 7, 2025
@hugovk
Copy link
Member

hugovk commented Jul 7, 2025

Thanks!

@hugovk hugovk merged commit 0b62523 into python:main Jul 7, 2025
36 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 7, 2025
@miss-islington-app
Copy link

Thanks @LamentXU123 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 7, 2025
@LamentXU123 @miss-islington
pythongh-101100: Fix Sphinx warnings in library/email.compat32-messag…
d04fbea 
…e.rst (pythonGH-136323)

(cherry picked from commit 0b62523)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 7, 2025

GH-136389 is a backport of this pull request to the 3.14 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 7, 2025
@LamentXU123 @miss-islington
pythongh-101100: Fix Sphinx warnings in library/email.compat32-messag…
234091f 
…e.rst (pythonGH-136323)

(cherry picked from commit 0b62523)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 7, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 7, 2025

GH-136390 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 7, 2025
hugovk pushed a commit that referenced this pull request Jul 7, 2025
@miss-islington @LamentXU123
[3.14] gh-101100: Fix Sphinx warnings in library/email.compat32-messa…
5a7d266 
…ge.rst (GH-136323) (#136389)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request Jul 7, 2025
@miss-islington @LamentXU123
[3.13] gh-101100: Fix Sphinx warnings in library/email.compat32-messa…
f39103b 
…ge.rst (GH-136323) (#136390)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
@LamentXU123 @AndPuQing
pythongh-101100: Fix Sphinx warnings in library/email.compat32-messag…
e1ea753 
…e.rst (python#136323)
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@LamentXU123 @Pranjal095
pythongh-101100: Fix Sphinx warnings in library/email.compat32-messag…
ef7bd16 
…e.rst (python#136323)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LamentXU123 @hugovk
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy