FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-104679 Fixed syntax highlighting in turtle docs by millefalcon · Pull Request #104682 · python/cpython · GitHub

/ cpython Public

gh-104679 Fixed syntax highlighting in turtle docs - #104682

Merged
hugovk merged 4 commits into
python:mainfrom
millefalcon:fix/syntax-highlighting-turtle-docs
May 20, 2023
ConversationCommits (4)ChecksFiles changed
Merged

gh-104679 Fixed syntax highlighting in turtle docs#104682
hugovk merged 4 commits into
python:mainfrom
millefalcon:fix/syntax-highlighting-turtle-docs

Conversation

millefalcon commented May 20, 2023 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Fixed indentation for the code snippets in turtle library docs which was causing syntax highlighting issues

closes #104679

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

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels May 20, 2023
millefalcon mentioned this pull request May 20, 2023
Closed
millefalcon changed the title Fixed syntax highlighting in turtle docs gh-104679 Fixed syntax highlighting in turtle docs May 20, 2023
hugovk reviewed May 20, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks! Mostly looks good, one suggestion.

Comment thread Doc/library/turtle.rst Outdated
Comment on lines +2026 to +2038
>>> screen.register_shape("turtle.gif")

.. note::
Image shapes *do not* rotate when turning the turtle, so they do not
display the heading of the turtle!
.. note::
Image shapes *do not* rotate when turning the turtle, so they do not
display the heading of the turtle!

(2) *name* is an arbitrary string and *shape* is a tuple of pairs of
coordinates: Install the corresponding polygon shape.

.. doctest::
:skipif: _tkinter is None
.. doctest::
:skipif: _tkinter is None

>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))
>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))

hugovk May 20, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think the indent might have been correct before? The HTML looks better nested.

Before: https://docs.python.org/3.12/library/turtle.html#turtle.addshape

After: https://cpython-previews--104682.org.readthedocs.build/en/104682/library/turtle.html#turtle.addshape

millefalcon May 20, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh, right. My bad. Will fix soon

millefalcon May 20, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@hugovk Fixed. Is that fine ? 😅

millefalcon May 20, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

hugovk May 20, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you!

millefalcon May 20, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

No problem 👍 and thank you

hugovk merged commit 2c97878 into python:main May 20, 2023

miss-islington commented May 20, 2023

Copy link
Copy Markdown
Contributor

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

miss-islington commented May 20, 2023

Copy link
Copy Markdown
Contributor

Sorry, @millefalcon and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2c97878bb8a09f5aba8bf413bb794f6efd5065df 3.11

millefalcon deleted the fix/syntax-highlighting-turtle-docs branch May 20, 2023 15:43
millefalcon restored the fix/syntax-highlighting-turtle-docs branch May 20, 2023 15:44

hugovk commented May 20, 2023

Copy link
Copy Markdown
Member

@millefalcon Would you like to make the same change for the 3.11 branch? (No requirement to use cherry_picker.)

millefalcon commented May 20, 2023

Copy link
Copy Markdown
Contributor Author

@hugovk Sure. Let me check what one needs to do for targetting a specific branch. Thanks 👍

bedevere-bot commented May 20, 2023

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.11 only security fixes label May 20, 2023
millefalcon added a commit to millefalcon/cpython that referenced this pull request May 20, 2023
[3.11] pythongh-104679 Fixed syntax highlighting in turtle docs (pyth…
89cc223 
…onGH-104682).

(cherry picked from commit 2c97878)

Co-authored-by: han-solo <hanish0019@gmail.com>
terryjreedy pushed a commit that referenced this pull request May 20, 2023
[3.11] gh-104679 Fixed syntax highlighting in turtle docs (GH-104682). (
89bd454 
#104695)

(cherry picked from commit 2c97878)
millefalcon deleted the fix/syntax-highlighting-turtle-docs branch May 20, 2023 16:38
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk left review comments

Assignees

hugovk

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Syntax highlighting issue in Turtle docs

4 participants

Back | FazBrowse Home | New Git URL