Skip to content

gh-157847: Reorganize turtle documentation - #157868

Merged
StanFromIreland merged 3 commits into
python:mainfrom
StanFromIreland:turtle/reshuffle
Sep 28, 2026
Merged

StanFromIreland merged 3 commits into
python:mainfrom
StanFromIreland:turtle/reshuffle

Conversation

@StanFromIreland

@StanFromIreland StanFromIreland commented Sep 20, 2026 •

Copy link
Copy Markdown
Member

This PR stacks on #157854, when that's merged a chunk of the diff here will disappear. This continues with my plan to reorganise the documentation.

It removes the old reference section, as I've corrected the nesting levels of headers in the main reference, the sidebar now obsoletes it.

Note: I don't want to touch the How To section in this PR, for reviewing purposes. That's left for a follow up, currently, it's copied as-is with a few additional bits merged in.

@read-the-docs-community

read-the-docs-community Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

@StanFromIreland

Copy link
Copy Markdown
Member Author

This is ready to review now.

CC @terryjreedy @CAM-Gerlach if you're interested, could you please take a look?

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@StanFromIreland

Copy link
Copy Markdown
Member Author

This now incorporates some additional fixes from Hugo from my previous re-write of the introduction.

I ask however, that suggestions for the existing text not be made in this PR (but in a future one). I tried to focus on moving content as-is, so that it'll be easier for people to go through it in the Git history.

@StanFromIreland

Copy link
Copy Markdown
Member Author

If there are no comments, I plan to merge this next week.

I will then be sending PRs for each section, as I'd like to tidy them up, so if anything comes up I can also address it then.

@terryjreedy

Copy link
Copy Markdown
Member

Moving the how-tos down seems sensible. The crazy side-by-side diff is nearly useless for review. Instead I looked at the old and new html renderings in separate tabs, in particular the sidebars. Much, much improved. As near as I could tell, everything went somewhere.

I think some headers could be reworded, but that should be done in a separate PR, where the old and new versions would appear side-by-side for review. This includes the how-to names.

@StanFromIreland

Copy link
Copy Markdown
Member Author

Much, much improved.

That's nice to hear, thanks Terry :-)

This includes the how-to names.

Yes, I plan to do that, along with some other little changes in the section in a follow up PR.

@terryjreedy

Copy link
Copy Markdown
Member

Please backport and get this in the releases next week.

@StanFromIreland StanFromIreland added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Sep 26, 2026
@StanFromIreland
StanFromIreland merged commit 4c3cb33 into python:main Sep 28, 2026
31 checks passed
@StanFromIreland
StanFromIreland deleted the turtle/reshuffle branch September 28, 2026 08:00
@miss-islington-app

Copy link
Copy Markdown

Thanks @StanFromIreland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158318 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Sep 28, 2026
@miss-islington-app

Copy link
Copy Markdown

Sorry, @StanFromIreland, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 4c3cb33db7a9eb037334c77d07d498aefe0ad282 3.13

@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158319 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Sep 28, 2026
StanFromIreland added a commit that referenced this pull request Sep 28, 2026
)

(cherry picked from commit 4c3cb33)

Co-authored-by: Stan Ulbrych <stan@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158321 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 Sep 28, 2026
StanFromIreland added a commit that referenced this pull request Sep 28, 2026
)

(cherry picked from commit 4c3cb33)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Sep 28, 2026
)

Co-authored-by: Stan Ulbrych <stan@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
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.

2 participants