Skip to content

Conversation

@LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Oct 11, 2025

signal.rst:270: WARNING: c:func reference target not found: signal [ref.func]
signal.rst:668: WARNING: py:attr reference target not found: si_signo [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_code [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_errno [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_pid [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_uid [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_status [ref.attr]
signal.rst:668: WARNING: py:attr reference target not found: si_band [ref.attr]
  • The c:func referrence in line 270 was suppressed
  • In line 668, the py:attr references were namely the attr of siginfo_t structure. In library os we also mentioned this structure in function waitid:
   The return value is an object representing the data contained in the
   :c:type:`siginfo_t` structure with the following attributes:

   * :attr:`!si_pid` (process ID)
   * :attr:`!si_uid` (real user ID of the child)
   * :attr:`!si_signo` (always :const:`~signal.SIGCHLD`)
   * :attr:`!si_status` (the exit status or signal number, depending on :attr:`!si_code`)
   * :attr:`!si_code` (see :data:`CLD_EXITED` for possible values)

So I just suppress all of them, similar to how we did in os.rst


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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Oct 11, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 11, 2025
Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

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

! syntax should be reserved for actual Python APIs that we haven't documented, not for Unix APIs that aren't part of Python at all. Please make these an inline codeblock instead.

@bedevere-app
Copy link

bedevere-app bot commented Oct 11, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@LamentXU123
Copy link
Contributor Author

I have made the requested changes; please review again

Should I add these changes to document of os either?

@bedevere-app
Copy link

bedevere-app bot commented Oct 11, 2025

Thanks for making the requested changes!

@ZeroIntensity: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from ZeroIntensity October 11, 2025 14:04
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 11, 2025
@ZeroIntensity ZeroIntensity merged commit 447c7a8 into python:main Oct 11, 2025
34 of 35 checks passed
@miss-islington-app
Copy link

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

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Oct 11, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 11, 2025
…honGH-139930)

(cherry picked from commit 447c7a8)

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 Oct 11, 2025
…honGH-139930)

(cherry picked from commit 447c7a8)

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

bedevere-app bot commented Oct 11, 2025

GH-139966 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 Oct 11, 2025
@bedevere-app
Copy link

bedevere-app bot commented Oct 11, 2025

GH-139967 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 Oct 11, 2025
ZeroIntensity pushed a commit that referenced this pull request Oct 11, 2025
…-139930) (GH-139966)

gh-101100: Fix Sphinx warnings in `Doc/library/signal.rst` (GH-139930)
(cherry picked from commit 447c7a8)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
ZeroIntensity pushed a commit that referenced this pull request Oct 11, 2025
…-139930) (GH-139967)

gh-101100: Fix Sphinx warnings in `Doc/library/signal.rst` (GH-139930)
(cherry picked from commit 447c7a8)

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

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants