gh-106996: Rewrite turtle explanation #107244
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Simplified the language and presentation of the concepts being discussed, to make clearer the relations between them and the useful entry-points for a typical user. Moved the section to below the reference material, to follow the tutorial > how-to > reference > explanation pattern.
hugovk
reviewed
Jul 27, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
|
Thanks! |
|
GH-107335 is a backport of this pull request to the 3.12 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 27, 2023
(cherry picked from commit ccd4253) Co-authored-by: Daniele Procida <daniele@vurt.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
|
GH-107336 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 27, 2023
(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 pull request
Jul 27, 2023
hugovk
added a commit
that referenced
this pull request
Jul 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Simplified the language and presentation of the concepts being
discussed, to make clearer the relations between them and the
useful entry-points for a typical user.
Moved the section to below the reference material, to follow
the tutorial > how-to > reference > explanation pattern.
📚 Documentation preview 📚: https://cpython-previews--107244.org.readthedocs.build/