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 turtle.rst #109394

Merged
merged 1 commit into from
Sep 14, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Sep 14, 2023

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/

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

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 :)

Copy link
Member

@terryjreedy terryjreedy left a comment

Choose a reason for hiding this comment

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

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 terryjreedy added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Sep 14, 2023
@terryjreedy terryjreedy merged commit 21e80f4 into python:main Sep 14, 2023
28 checks passed
@miss-islington
Copy link
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
(cherry picked from commit 21e80f4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Sep 14, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 14, 2023
@bedevere-app
Copy link

bedevere-app bot commented Sep 14, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Sep 14, 2023
@terryjreedy
Copy link
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
(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
…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
…09416)

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

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants