Skip to content
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.

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

gh-101100: Fix sphinx warnings in threading.rst #108684

Merged
merged 3 commits into from
Aug 31, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Aug 30, 2023

Original warnings:

/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:274: WARNING: py:mod reference target not found: _threading_local
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:283: WARNING: py:meth reference target not found: Thread.__init__
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:339: WARNING: py:class reference target not found: ThreadGroup
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:1012: WARNING: py:meth reference target not found: Timer.start
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:1150: WARNING: py:meth reference target not found: acquire
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:1150: WARNING: py:meth reference target not found: release
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:1150: WARNING: py:meth reference target not found: acquire
/Users/sobolev/Desktop/cpython/Doc/library/threading.rst:1150: WARNING: py:meth reference target not found: release

Couple of comments:

  • _threading_local module is not documented as a module in sphinx
  • Thread.__init__() is used the same way in other places as well, __init__ is not documented in sphinx
  • ThreadGroup does not exist at the moment
  • :meth:Timer.start <Thread.start> is used because Timer is Thread subclass and Timer.start is not documented
  • release and acquire are used as general conventions, not exact methods

Doc/library/threading.rst Outdated Show resolved Hide resolved
@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Aug 30, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@hugovk
Copy link
Member

hugovk commented Aug 30, 2023

Thanks!

@hugovk hugovk merged commit 991e4e7 into python:main Aug 31, 2023
17 checks passed
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Aug 31, 2023
@bedevere-bot
Copy link

GH-108708 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 31, 2023
)

(cherry picked from commit 991e4e7)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 31, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 31, 2023
)

(cherry picked from commit 991e4e7)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Aug 31, 2023
…108708)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Aug 31, 2023
…108707)

gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684)
(cherry picked from commit 991e4e7)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants