Skip to content

gh-101100: Fix sphinx warnings in Doc/library/platform.rst #136562

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 12, 2025
Merged

gh-101100: Fix sphinx warnings in Doc/library/platform.rst #136562

merged 2 commits into from
Jul 12, 2025
+2 −3

Conversation

LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Jul 12, 2025 •
edited by github-actions bot
Loading

There are two warnings:

C:\Users\admin\Downloads\cpython-main\Doc\library\platform.rst:178: WARNING: py:attr reference target not found: sysname [ref.attr]
C:\Users\admin\Downloads\cpython-main\Doc\library\platform.rst:178: WARNING: py:attr reference target not found: nodename [ref.attr]

The original rst file is:

   Note: the first two attribute names differ from the names presented by
   :func:`os.uname`, where they are named :attr:`sysname` and
   :attr:`nodename`.

The Doc of func os.uname indicates that sysname and nodename is it's attr.

image

Since we've already got a ref to func os.uname, I suggest we can subpress those two links.

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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 12, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 12, 2025
Open
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 12, 2025
serhiy-storchaka
serhiy-storchaka approved these changes Jul 12, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Since we've already got a ref to func os.uname, I suggest we can subpress those two links.

Agree. LGTM.

@serhiy-storchaka serhiy-storchaka merged commit 47b01da into python:main Jul 12, 2025
37 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 12, 2025
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 12, 2025
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 12, 2025
@LamentXU123 @miss-islington
pythongh-101100: Fix sphinx warnings in Doc/library/platform.rst (pyt…
e2001e1 
…honGH-136562)

(cherry picked from commit 47b01da)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 12, 2025
@LamentXU123 @miss-islington
pythongh-101100: Fix sphinx warnings in Doc/library/platform.rst (pyt…
44c6377 
…honGH-136562)

(cherry picked from commit 47b01da)

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

bedevere-app bot commented Jul 12, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 12, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 12, 2025

GH-136598 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 12, 2025
serhiy-storchaka pushed a commit that referenced this pull request Jul 12, 2025
@miss-islington @LamentXU123
[3.14] gh-101100: Fix sphinx warnings in Doc/library/platform.rst (GH…
d351f29 
…-136562) (GH-136597)

(cherry picked from commit 47b01da)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
serhiy-storchaka pushed a commit that referenced this pull request Jul 12, 2025
@miss-islington @LamentXU123
[3.13] gh-101100: Fix sphinx warnings in Doc/library/platform.rst (GH…
39f36a1 
…-136562) (GH-136598)

(cherry picked from commit 47b01da)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@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 @serhiy-storchaka
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