Repository navigation
Restructure the turtle documentation #157847
Description
Documentation
Currently, it's a little messy. We have obsolete sections (#157846) and several that seem to duplicate each other. Inspired by #94635, I will restructure the documentation remove the duplicated content, and to have a clearer order and table of contents than what we have now. A rough plan:
turtle --- Turtle graphics
(intro prose, merges "Introduction" and "Get started",
keep the sidebar image, then optional-module include plus the Tk
note from the how-to, then a "This document includes four main
sections:" like in sqlite3 documentation)
Tutorial
Starting a turtle environment
Basic drawing
Making algorithmic patterns
etc.
Reference
Turtle methods and functions (current "Methods of RawTurtle/Turtle...")
Screen methods and functions (current "Methods of TurtleScreen/Screen...")
Classes (current "Public classes")
Exceptions
How-to guides
How to automatically begin and end filling
How to use the turtle module namespace
How to use turtle graphics in a script
How to use object-oriented turtle graphics
How to use help (moved from "Help and configuration")
How to configure Screen and Turtles (moved from "Help and configuration")
Explanation
The object-oriented interface (current "Explanation")
turtledemo --- Demo scripts (unchanged)
Linked PRs
- gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sections from
turtledocs #157846 - [3.15] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sections from
turtledocs (GH-157846) #157849 - [3.14] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sections from
turtledocs (GH-157846) #157850 - [3.13] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sections from
turtledocs (#157846) #157851 - gh-157847: Rewrite
turtlemodule docs introduction #157854 - gh-157847: Reorganize
turtledocumentation #157868 - [3.15] gh-157847: Rewrite
turtlemodule docs introduction (GH-157854) #158094 - [3.14] gh-157847: Rewrite
turtlemodule docs introduction (GH-157854) #158096 - [3.13] gh-157847: Rewrite
turtlemodule docs introduction (GH-157854) #158104 - [3.15] gh-157847: Reorganize
turtledocumentation (GH-157868) #158318 - [3.14] gh-157847: Reorganize
turtledocumentation (GH-157868) #158319 - [3.13] gh-157847: Reorganize
turtledocumentation (GH-157868) #158321 - gh-157847: Tidy up turtle motion docstrings and docs in
turtlemodule #158330 - [3.15] gh-157847: Tidy up turtle motion docstrings and docs in
turtlemodule (GH-158330) #158365 - [3.14] gh-157847: Tidy up turtle motion docstrings and docs in
turtlemodule (GH-158330) #158366 - [3.13] gh-157847: Tidy up turtle motion docstrings and docs in
turtlemodule (GH-158330) #158367 - gh-157847: Improve more
turtledocstrings and docs #158562 - [3.14] gh-157847: Improve more
turtledocstrings and docs (GH-158562) #159171 - [3.15] gh-157847: Improve more
turtledocstrings and docs (GH-158562) #159172 - gh-157847: Clean up another portion of the
turtledocumentation #160620
Metadata
Metadata
Assignees
Projects
- Status
- Status
Activity
gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sections fr…
[3.14] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sect…
[3.13] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sect…
[-]Resutructure the `turtle` documentation[/-][+]Restructure the `turtle` documentation[/+][3.15] gh-157847: Remove obsolete "Changes since Python 2.6/3.0" sect…
gh-157847: Rewrite `turtle` module docs introduction (#157854)
[3.14] gh-157847: Rewrite `turtle` module docs introduction (GH-157854)…
[3.15] gh-157847: Rewrite `turtle` module docs introduction (GH-157854)…
[3.13] gh-157847: Rewrite `turtle` module docs introduction (GH-157854)…
gh-157847: Reorganize `turtle` documentation (#157868)
2 remaining items
[3.15] gh-157847: Reorganize `turtle` documentation (GH-157868) (#158318
gh-157847: Tidy up turtle motion docstrings and docs in `turtle` modu…
[3.13] gh-157847: Tidy up turtle motion docstrings and docs in `turtl…
[3.14] gh-157847: Tidy up turtle motion docstrings and docs in `turtl…
[3.15] gh-157847: Tidy up turtle motion docstrings and docs in `turtl…
gh-157847: Improve more `turtle` docstrings and docs (#158562)
[3.15] gh-157847: Improve more `turtle` docstrings and docs (GH-158562)…
[3.14] gh-157847: Improve more `turtle` docstrings and docs (GH-158562)…
pythongh-157847: Improve more `turtle` docstrings and docs (python#15…
gh-157847: Re-write more of the `turtle` reference docs (#159685)
[3.14] gh-157847: Re-write more of the `turtle` reference docs (GH-15…
[3.15] gh-157847: Re-write more of the `turtle` reference docs (GH-15…