FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix sphinx warnings in `threading.rst` by sobolevn · Pull Request #108684 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Merged
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-threading
Aug 31, 2023
ConversationCommits (3)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in threading.rst#108684
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-threading

Conversation

sobolevn commented Aug 30, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

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

sobolevn requested a review from hugovk August 30, 2023 12:32
bedevere-bot added docs Documentation in the Doc dir skip news labels Aug 30, 2023
bedevere-bot mentioned this pull request Aug 30, 2023
Closed
hugovk reviewed Aug 30, 2023
View reviewed changes
Comment thread Doc/library/threading.rst Outdated
hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 30, 2023
Update Doc/library/threading.rst
27ac0cc 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk commented Aug 30, 2023

Copy link
Copy Markdown
Member

Thanks!

hugovk merged commit 991e4e7 into python:main Aug 31, 2023

miss-islington commented Aug 31, 2023

Copy link
Copy Markdown
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 commented Aug 31, 2023

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 31, 2023

bedevere-bot commented Aug 31, 2023

Copy link
Copy Markdown

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
pythongh-101100: Fix sphinx warnings in threading.rst (pythonGH-108684
a9b0036 
)

(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 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
pythongh-101100: Fix sphinx warnings in threading.rst (pythonGH-108684
8d843d2 
)

(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
[3.11] gh-101100: Fix sphinx warnings in threading.rst (GH-108684) (#…
e93f572 
…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
[3.12] gh-101100: Fix sphinx warnings in threading.rst (GH-108684) (#…
bc42d6c 
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk 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.

4 participants

Back | FazBrowse Home | New Git URL