◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix Sphinx warnings in library/faulthandler.rst#118353

Merged
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-faulthandler
Apr 28, 2024
Merged

gh-101100: Fix Sphinx warnings in library/faulthandler.rst#118353
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-faulthandler

Conversation

@hugovk

@hugovk hugovk commented Apr 27, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Fix 13 warnings:

library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGSEGV
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGFPE
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGABRT
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGBUS
library/faulthandler.rst:11: WARNING: py:const reference target not found: SIGILL
library/faulthandler.rst:18: WARNING: c:func reference target not found: sigaltstack
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGSEGV
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGFPE
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGABRT
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGBUS
library/faulthandler.rst:73: WARNING: py:const reference target not found: SIGILL
library/faulthandler.rst:107: WARNING: c:func reference target not found: _exit
library/faulthandler.rst:107: WARNING: c:func reference target not found: _exit

Link the SIG* py:consts to the signal module, and add ! to the c:funcs which I don't think need documenting.

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

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels Apr 27, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Apr 27, 2024
Open
@AlexWaygood

AlexWaygood commented Apr 27, 2024

Copy link
Copy Markdown
Member

PR title is interesting 👀

@hugovk hugovk changed the title gh-101100: Add GitHub Action to ensure code changes include tests Apr 27, 2024
@hugovk

hugovk commented Apr 27, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

Haha, it was a mistake, corrected now!

I had some extra stuff on main, was playing around with https://github.com/brettcannon/check-for-changed-files/ to try python/core-workflow#480 (didn't get it working...). Rebased my branch before creating the PR but it kept the old default title :)

@hugovk hugovk changed the title gh-101100: Fix Sphinx warnings in library/faulthandler.rst Apr 27, 2024
@hugovk hugovk merged commit 33c6cf3 into python:main Apr 28, 2024
@hugovk hugovk deleted the docs-fix-sphinx-warnings-faulthandler branch April 28, 2024 18:06
@miss-islington-app

miss-islington-app Bot commented Apr 28, 2024

Copy link
Copy Markdown

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 28, 2024
@hugovk @miss-islington
pythongh-101100: Fix Sphinx warnings in library/faulthandler.rst (p… …
cb9a6bd 
…ythonGH-118353)

(cherry picked from commit 33c6cf3)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Apr 28, 2024

Copy link
Copy Markdown

GH-118366 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Apr 28, 2024
hugovk added a commit that referenced this pull request Apr 28, 2024
@miss-islington @hugovk
[3.12] gh-101100: Fix Sphinx warnings in library/faulthandler.rst (G… …
817190c 
…H-118353) (#118366)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hugovk @AlexWaygood