8000 Make comment from literal block in turtle.rst by rffontenelle · Pull Request #128831 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Make comment from literal block in turtle.rst #128831

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 14, 2025
Merged

Make comment from literal block in turtle.rst #128831

merged 1 commit into from
Jan 14, 2025

Conversation

rffontenelle
Copy link
Contributor
@rffontenelle rffontenelle commented Jan 14, 2025 •
edited by github-actions bot
Loading

These lines are presented as code output, but their content are comments. There are no other occurrence of this text outside this document, which confirms this.

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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Jan 14, 2025
@picnixz
Copy link
Member
picnixz commented Jan 14, 2025

I'm perplexed that this wasn't picked up by doctest. Is it because there was a blank line before (and it was then considered an indented block) or is this something else?

@picnixz picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jan 14, 2025
@picnixz
Copy link
Member
picnixz commented Jan 14, 2025

@vstinner: I plan to merge this one with the following title:

Fix a `.. doctest::` block in `Doc/library/turtle.rst`.

and no commit message.

vstinner
vstinner approved these changes Jan 14, 2025
View reviewed changes
Copy link
Member
@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM. But I prefer to keep the PR title, or use:

Fix a "doctest" block in `Doc/library/turtle.rst`

@picnixz picnixz merged commit 1598e18 into python:main Jan 14, 2025
42 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 14, 2025
@rffontenelle @miss-islington
Fix a "doctest" block in Doc/library/turtle.rst (pythonGH-128831)
a03d636 
(cherry picked from commit 1598e18)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@bedevere-app
Copy link
bedevere-app bot commented Jan 14, 2025

GH-128835 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 14, 2025
@rffontenelle @miss-islington
Fix a "doctest" block in Doc/library/turtle.rst (pythonGH-128831)
76a1036 
(cherry picked from commit 1598e18)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@bedevere-app
Copy link
bedevere-app bot commented Jan 14, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jan 14, 2025
@picnixz
Copy link
Member
picnixz commented Jan 14, 2025

I decided to keep the mention to the doctest block as it would highlight more precisely what changed.

Thank you for the PR @rffontenelle (and the other PRs of the same kind you're writing as well; this takes time and we appreciate you doing this!)

picnixz pushed a commit that referenced this pull request Jan 14, 2025
@miss-islington @rffontenelle
[3.12] Fix a "doctest" block in Doc/library/turtle.rst (GH-128831) (#…
54c9597 
…128836)

Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831)
(cherry picked from commit 1598e18)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
picnixz pushed a commit that referenced this pull request Jan 14, 2025
@miss-islington @rffontenelle
[3.13] Fix a "doctest" block in Doc/library/turtle.rst (GH-128831) (#…
0998eb6 
…128835)

Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831)
(cherry picked from commit 1598e18)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@rffontenelle rffontenelle deleted the patch-9 branch January 18, 2025 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vstinner vstinner vstinner approved these changes

@picnixz picnixz picnixz approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rffontenelle @picnixz @vstinner
0