Skip to content

Improve Turtle graphics documentation #106996

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
Open
evildmp opened this issue Jul 22, 2023 · 1 comment
Open

Improve Turtle graphics documentation #106996

evildmp opened this issue Jul 22, 2023 · 1 comment
Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@evildmp
Copy link
Contributor

evildmp commented Jul 22, 2023 •
edited by bedevere-bot
Loading

Improving the turtle graphics documentation via a series of PRs

The turtle graphics module has some comprehensive documentation, but could be improved with some:

  • restructuring
  • new material aimed at getting users more quickly into a successful experience

I propose to do this via a series of small PRs each targeting a particular incremental improvement.

Pitch

The Turtle graphics module looks like a good place where Diátaxis can be applied. It's quite self-contained, and will be an effective showcase for that kind of work.

I will submit small PRs (some could be very small), so that the purpose of each one is clear, and together they will provide a readable history of how documentation improvement works in practice under Diátaxis.

Linked PRs
@evildmp evildmp added the type-feature A feature request or enhancement label Jul 22, 2023
@bedevere-bot bedevere-bot mentioned this issue Jul 22, 2023
Merged
hugovk added a commit that referenced this issue Jul 22, 2023
@evildmp @hugovk
gh-106996: Amend the introduction to the turtle graphics documentation (
f8f16d0 
#106997)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 22, 2023
Merged
hugovk added a commit that referenced this issue Jul 23, 2023
@evildmp @hugovk
gh-106996: Add the basics of a turtle graphics tutorial (#107072)
a2a0e51 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
evildmp added a commit to evildmp/cpython that referenced this issue Jul 23, 2023
@evildmp
[3.12] pythongh-106996: Add the basics of a turtle graphics tutorial (p…
751da07 
…ythonGH-107072)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.
(cherry picked from commit a2a0e51)

Co-authored-by: Daniele Procida <daniele@vurt.org>
This was referenced Jul 23, 2023
Merged
Merged
hugovk pushed a commit that referenced this issue Jul 23, 2023
@evildmp
[3.12] gh-106996: Add the basics of a turtle graphics tutorial (GH-10…
f7e1300 
…7072) (#107109)
hugovk pushed a commit that referenced this issue Jul 23, 2023
@evildmp
[3.11] gh-106996: Add the basics of a turtle graphics tutorial (GH-10…
6e3a2fb 
…7072) (#107110)
jtcave pushed a commit to jtcave/cpython that referenced this issue Jul 23, 2023
@evildmp @hugovk @jtcave
pythongh-106996: Add the basics of a turtle graphics tutorial (python…
28659a6 
…#107072)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 23, 2023
Merged
mementum pushed a commit to mementum/cpython that referenced this issue Jul 23, 2023
@evildmp @hugovk @mementum
pythongh-106996: Add the basics of a turtle graphics tutorial (python…
4f1e8db 
…#107072)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this issue Jul 25, 2023
@evildmp @hugovk
gh-106996: Add a how-to section to the turtle documentation (#107153)
2425346 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 25, 2023
@evildmp @hugovk @miss-islington
pythongh-106996: Add a how-to section to the turtle documentation (py…
4a3eaaf 
…thonGH-107153)

(cherry picked from commit 2425346)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 25, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 25, 2023
@evildmp @hugovk @miss-islington
pythongh-106996: Add a how-to section to the turtle documentation (py…
5ef867a 
…thonGH-107153)

(cherry picked from commit 2425346)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 25, 2023
@evildmp @hugovk @miss-islington
pythongh-106996: Add a how-to section to the turtle documentation (py…
1ac46d1 
…thonGH-107153)

(cherry picked from commit 2425346)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 25, 2023
Merged
hugovk added a commit that referenced this issue Jul 25, 2023
@miss-islington @evildmp @hugovk
[3.11] gh-106996: Add a how-to section to the turtle documentation (G…
1bc1609 
…H-107153) (#107234)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this issue Jul 25, 2023
@miss-islington @evildmp @hugovk
[3.12] gh-106996: Add a how-to section to the turtle documentation (G…
fab36fb 
…H-107153) (#107233)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 25, 2023
Merged
jtcave pushed a commit to jtcave/cpython that referenced this issue Jul 27, 2023
@evildmp @hugovk @jtcave
pythongh-106996: Add a how-to section to the turtle documentation (py…
9720ae8 
…thon#107153)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This was referenced Jul 27, 2023
Merged
Merged
hugovk added a commit that referenced this issue Jul 27, 2023
@evildmp @hugovk
gh-106996: Rewrite turtle explanation (#107244)
ccd4253 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 27, 2023
@evildmp @hugovk @miss-islington
pythongh-106996: Rewrite turtle explanation (pythonGH-107244)
f8a7e88 
(cherry picked from commit ccd4253)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 27, 2023
@evildmp @hugovk @miss-islington
pythongh-106996: Rewrite turtle explanation (pythonGH-107244)
a49f938 
(cherry picked from commit ccd4253)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this issue Jul 27, 2023
@miss-islington @evildmp @hugovk
[3.12] gh-106996: Rewrite turtle explanation (GH-107244) (#107335)
38c982d 
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this issue Jul 27, 2023
@miss-islington @evildmp @hugovk
[3.11] gh-106996: Rewrite turtle explanation (GH-107244) (#107336)
8f0dc18 
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@iritkatriel iritkatriel added the stdlib Python modules in the Lib dir label Nov 28, 2023
@StanFromIreland
Copy link
Contributor

Is there anything else to do here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement
Projects
Turtle issues 🐢
Status: No status
Milestone
No milestone
Development

No branches or pull requests
3 participants
@evildmp @iritkatriel @StanFromIreland