GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-157847: Improve more `turtle` docstrings and docs by StanFromIreland · Pull Request #158562 · python/cpython

Conversation

@StanFromIreland

@StanFromIreland StanFromIreland commented Oct 1, 2026 •
edited by bedevere-app Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

This continues the work started in #158281 and #158330. It improves the reference docs and docstrings, modernising them, making them easier to understand/clearer, and consistent.

Yes, a few could reasonably be classified as churn, however, the turtle module is, frankly, quite messy in places. I think these changes improve readability and, as a result, maintainability, so I intend to tidy up similar issues. They should also have relatively little impact on useful Git history, since the majority of the affected lines date back to the original port in 97cf99f.

  • Issue: Restructure the turtle documentation #157847

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
m-aciek reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@StanFromIreland
Improve more turtle docstrings and docs
6ccfffe
@StanFromIreland
StanFromIreland requested review from m-aciek and willingc October 1, 2026 12:24
@StanFromIreland
StanFromIreland requested a review from terryjreedy as a code owner October 1, 2026 12:24
@StanFromIreland StanFromIreland added skip issue skip news labels Oct 1, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Oct 1, 2026
Restructure the turtle documentation #157847
Open
@bedevere-app bedevere-app Bot added the awaiting core review label Oct 1, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 1, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35070633 | 📁 Comparing 4fd9abc against main (0906d2a)

  🔍 Preview build  

25 files changed · ± 25 modified

± Modified

  • _static/tachyon-example-heatmap.html
  • c-api/bytes.html
  • c-api/exceptions.html
  • c-api/extension-modules.html
  • c-api/interp-lifecycle.html
  • c-api/memory.html
  • c-api/refcounting.html
  • c-api/slots.html
  • c-api/stable.html
  • c-api/structures.html
  • and 15 more...
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@StanFromIreland
Fix example typo
98f665c
@terryjreedy

terryjreedy commented Oct 1, 2026

Copy link
Copy Markdown
Member

To review, I needed to experiment. To refresh my memory, I followed the tutorial. In "Starting a turtle environment", the import is insufficient. It does not 'start a turtle environment'. Add reset() to the code example and text "The reset command opens a default screen with a default turtle at its default position and orientation." directly below. Starting with forward 'worked' in that it first calls reset, but it was jarring and uncomfortable doing so when there was nothing visible.

I would add this to this PR.
StanFromIreland reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@StanFromIreland @terryjreedy
Apply Terry's suggestion
a723444 
Co-authored-by: Terry Reedy <[email protected]>
@StanFromIreland

StanFromIreland commented Oct 1, 2026

Copy link
Copy Markdown
Member Author

Yeah, the tutorial (like all of the sections) needs some work. But, I'm happy to apply your suggestion now if that aids reviewing :-) However, I switched reset() for showturtle().
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
terryjreedy
terryjreedy previously requested changes Oct 1, 2026
View reviewed changes
Comment thread Doc/library/turtle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting changes and removed awaiting core review labels Oct 1, 2026
@bedevere-app

bedevere-app Bot commented Oct 1, 2026

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@terryjreedy

terryjreedy commented Oct 1, 2026

Copy link
Copy Markdown
Member

Yes, showturtle() is a better name with the same visible effect.
m-aciek reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@StanFromIreland @terryjreedy
Apply Terry's suggestions.
f3f5085 
Co-authored-by: Terry Reedy <[email protected]>
@StanFromIreland

StanFromIreland commented Oct 1, 2026

Copy link
Copy Markdown
Member Author

I have made the requested changes; please review again
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting change review and removed awaiting changes labels Oct 1, 2026
@bedevere-app

bedevere-app Bot commented Oct 1, 2026

Copy link
Copy Markdown

Thanks for making the requested changes!

@terryjreedy: please review the changes made to this pull request.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app
bedevere-app Bot requested a review from terryjreedy October 1, 2026 20:26
@StanFromIreland

StanFromIreland commented Oct 6, 2026

Copy link
Copy Markdown
Member Author

If there are no further comments, I plan to merge this this weekend.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@terryjreedy
terryjreedy dismissed their stale review October 7, 2026 05:25

Requested changes made.

@bedevere-app bedevere-app Bot added awaiting review and removed awaiting change review labels Oct 7, 2026
@StanFromIreland
Merge branch 'main' into turtle/more-docstings
4fd9abc
@StanFromIreland
StanFromIreland merged commit 77f7b96 into python:main Oct 11, 2026
52 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@StanFromIreland
StanFromIreland deleted the turtle/more-docstings branch October 11, 2026 10:56
@bedevere-app bedevere-app Bot removed the awaiting review label Oct 11, 2026
@StanFromIreland StanFromIreland added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 11, 2026
@miss-islington-app

miss-islington-app Bot commented Oct 11, 2026

Copy link
Copy Markdown

Thanks @StanFromIreland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app

miss-islington-app Bot commented Oct 11, 2026

Copy link
Copy Markdown

Thanks @StanFromIreland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app

bedevere-app Bot commented Oct 11, 2026

Copy link
Copy Markdown

GH-159171 is a backport of this pull request to the 3.14 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 11, 2026
@bedevere-app

bedevere-app Bot commented Oct 11, 2026

Copy link
Copy Markdown

GH-159172 is a backport of this pull request to the 3.15 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 11, 2026
StanFromIreland added a commit that referenced this pull request Oct 11, 2026
@miss-islington @StanFromIreland @terryjreedy
[3.15] gh-157847: Improve more turtle docstrings and docs (GH-158562)…
8b02517 
… (#159172)

(cherry picked from commit 77f7b96)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Reedy <[email protected]>
StanFromIreland added a commit that referenced this pull request Oct 11, 2026
@miss-islington @StanFromIreland @terryjreedy
[3.14] gh-157847: Improve more turtle docstrings and docs (GH-158562)…
35ab5bc 
… (#159171)

(cherry picked from commit 77f7b96)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Reedy <[email protected]>
orsenthil pushed a commit to orsenthil/cpython that referenced this pull request Oct 11, 2026
@StanFromIreland @terryjreedy @orsenthil
pythongh-157847: Improve more turtle docstrings and docs (python#15…
36af3b3 
…8562)

Co-authored-by: Terry Reedy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@willingc willingc Awaiting requested review from willingc
@m-aciek m-aciek Awaiting requested review from m-aciek
@terryjreedy terryjreedy Awaiting requested review from terryjreedy terryjreedy is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@StanFromIreland @terryjreedy
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.