Skip to content
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.

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

gh-106996: Add a how-to section to the turtle documentation #107153

Merged
merged 10 commits into from
Jul 25, 2023

Conversation

evildmp
Copy link
Contributor

@evildmp evildmp commented Jul 23, 2023

This covers the basics of four different use-cases:

  • using commands directly in the shell (covered in more detail in the tutorial)
  • using the turtle module namespace
  • using turtle graphics in a script
  • using the object-oriented interface

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

evildmp and others added 6 commits July 22, 2023 11:10
This patch helps clarify the purpose, value and scope of the turtle
graphics module, by rewriting the introduction according to the
pattern:

* a single sentence that says **what the product (or thing) is**,
  as succinctly as possible
* a brief description of **what it does**
* a statement of its purpose or **the problem it solves**
* a note about **whom it is useful for**
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
The tutorial follows the practices outlined in
https://diataxis.fr/tutorials/. It uses the functional turtle
interface, and doesn't mention the object-oriented interface (which
would be a good next step).

Existing sections are now clearly labelled "Explanation" and
"Reference" to clarify their scope.
This covers the basics of four different use-cases:

* using commands directly in the shell (covered in more detail
  in the tutorial)
* using the turtle module namespace
* using turtle graphics in a script
* using the object-oriented interface
@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jul 25, 2023
@hugovk hugovk merged commit 2425346 into python:main Jul 25, 2023
19 checks passed
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 25, 2023
…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
Copy link

GH-107234 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 25, 2023
…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 removed the needs backport to 3.11 only security fixes label Jul 25, 2023
@hugovk hugovk added needs backport to 3.12 bug and security fixes and removed needs backport to 3.12 bug and security fixes labels Jul 25, 2023
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 25, 2023
…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>
hugovk added a commit that referenced this pull request Jul 25, 2023
…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 pull request Jul 25, 2023
…H-107153) (#107233)

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
jtcave pushed a commit to jtcave/cpython that referenced this pull request Jul 27, 2023
…thon#107153)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@picnixz picnixz removed the needs backport to 3.12 bug and security fixes label Sep 14, 2024
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.

6 participants