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

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

  1. python
  2. cpython

Repository navigation

gh-101100: Fix sphinx warnings in turtle.rst - #109394

Merged
terryjreedy merged 1 commit into
python:mainfrom
sobolevn:issue-101100-turtle
Sep 14, 2023
ConversationCommits (1)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in turtle.rst#109394
terryjreedy merged 1 commit into
python:mainfrom
sobolevn:issue-101100-turtle

Conversation

sobolevn commented Sep 14, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

It was:

/Users/sobolev/Desktop/cpython/Doc/library/turtle.rst:2318: WARNING: py:class reference target not found: tkinter.Canvas
/Users/sobolev/Desktop/cpython/Doc/library/turtle.rst:2333: WARNING: py:class reference target not found: tkinter.Canvas
/Users/sobolev/Desktop/cpython/Doc/library/turtle.rst:2415: WARNING: py:class reference target not found: tkinter.Canvas
/Users/sobolev/Desktop/cpython/Doc/library/turtle.rst:2421: WARNING: py:class reference target not found: tkinter.Canvas

But, since tkinter.Canvas is not documented in tkinter, we cannot reference it.

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

sobolevn requested a review from hugovk September 14, 2023 07:23
bedevere-app Bot mentioned this pull request Sep 14, 2023
Closed
AlexWaygood reviewed Sep 14, 2023
View reviewed changes

AlexWaygood left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Perhaps a better fix might be just to document tkinter.Canvas in the tkinter docs? I don't know much about tkinter, though,so maybe there's a reason why it's not documented currently :)

terryjreedy approved these changes Sep 14, 2023
View reviewed changes

terryjreedy left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks right given the current state of tkinter docs. The tkinter widget docs were referred to external sources. Only the ttk widget are documented (and with a few error as I remember). This should be fixed, and there may be an issue, but it will be a big project to do right.

terryjreedy added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 14, 2023
terryjreedy merged commit 21e80f4 into python:main Sep 14, 2023

miss-islington commented Sep 14, 2023

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 14, 2023
pythongh-101100: Fix sphinx warnings in turtle.rst (pythonGH-109394)
baa4f0b 
(cherry picked from commit 21e80f4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

bedevere-app Bot commented Sep 14, 2023

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Sep 14, 2023

bedevere-app Bot commented Sep 14, 2023

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Sep 14, 2023

terryjreedy commented Sep 14, 2023

Copy link
Copy Markdown
Member

If and when the tk widgets are documented, I (we) should hopefully remember to search .rst files for '!tkinter' to see where the '1' can/should be removed.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 14, 2023
pythongh-101100: Fix sphinx warnings in turtle.rst (pythonGH-109394)
cc6bbf9 
(cherry picked from commit 21e80f4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
terryjreedy pushed a commit that referenced this pull request Sep 14, 2023
[3.11] gh-101100: Fix sphinx warnings in turtle.rst (GH-109394) (#1…
8e23cd0 
…09417)

(cherry picked from commit 21e80f4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Yhg1s pushed a commit that referenced this pull request Sep 14, 2023
[3.12] gh-101100: Fix sphinx warnings in turtle.rst (GH-109394) (#1…
3bb8075 
…09416)

gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394)
(cherry picked from commit 21e80f4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
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

AlexWaygood AlexWaygood left review comments
terryjreedy terryjreedy approved these changes
hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees

No one assigned

Labels

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