Skip to content

Conversation

@sobolevn
Copy link
Member

@sobolevnsobolevn 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

@hugovkhugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 30, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@hugovk
Copy link
Member

Thanks!

@hugovkhugovk merged commit 991e4e7 into python:mainAug 31, 2023
@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-botbedevere-bot removed the needs backport to 3.12 only 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-botbedevere-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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@sobolevn@hugovk@miss-islington@bedevere-bot