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.

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

"wikipedia" turtledemo example in docs is supposed to be "rosette" #102135

Closed
SectorCorruptor opened this issue Feb 22, 2023 · 13 comments
Closed

"wikipedia" turtledemo example in docs is supposed to be "rosette" #102135

SectorCorruptor opened this issue Feb 22, 2023 · 13 comments
Labels
docs Documentation in the Doc dir easy

Comments

@SectorCorruptor
Copy link
Contributor

SectorCorruptor commented Feb 22, 2023 •
edited by bedevere-bot
Loading

The turtle module documentation, at this link has a section on turtledemo. It says the demo scripts are

  1. bytedesign
  2. chaos
  3. clock
  4. colormixer
  5. forest
  6. fractalcurves
  7. lindenmayer
  8. minimal_hanoi
  9. nim
  10. paint
  11. peace
  12. penrose
  13. planet_and_moon
  14. round_dance
  15. sorting_animate
  16. tree
  17. two_canvases
  18. wikipedia
  19. yinyang

The second last example is wrong. In my Python, the turtledemo list shows wikipedia as rosette. Is the rosette title wrong, or is it the wikipedia title?

Linked PRs
@SectorCorruptor SectorCorruptor added the docs Documentation in the Doc dir label Feb 22, 2023
@hugovk
Copy link
Member

hugovk commented Feb 22, 2023

Using git log --all --full-history -- Lib/turtledemo/wikipedia.py, I see the file was renamed in #58325 / #8002 but the documentation was updated:

The 'wikipedia' example is now 'rosette', decribing what it draws.

Would you like to create a PR to update the docs?

The file to change is https://github.com/python/cpython/blob/main/Doc/library/turtle.rst

@hugovk hugovk added the easy label Feb 22, 2023
@SectorCorruptor
Copy link
Contributor Author

Yeah, I will

@hugovk
Copy link
Member

hugovk commented Feb 22, 2023

Great! You can create a PR by clicking "Compare" next to the patch-1 branch at https://github.com/UndoneStudios/cpython/branches and then the green "Create pull request".

One suggestion: let's keep them in alphabetical order.

@SectorCorruptor
Copy link
Contributor Author

Isn't it already in alphabetical order?

@hugovk
Copy link
Member

hugovk commented Feb 22, 2023

Yes, the original "two_canvases, wikipedia, yinyang" is in alphabetical order, but "two_canvases, rosette, yinyang" isn't.

@SectorCorruptor
Copy link
Contributor Author

Well, keeping it in alphabetical order is a pain. Hold on as I try to modify it...

@SectorCorruptor
Copy link
Contributor Author

I'm a little busy right now, so I can't make the PR request

@hugovk
Copy link
Member

hugovk commented Feb 22, 2023 •
edited
Loading

It's been broken for 11 5 years, so no rush :)

The thing to do would be to cut the three lines 2460-2462 and paste them at line 2447, before round_dance.

@SectorCorruptor
Copy link
Contributor Author

Thanks a lot for that tip!

@SectorCorruptor SectorCorruptor mentioned this issue Feb 22, 2023
Merged
@SectorCorruptor
Copy link
Contributor Author

I... don't think it went well:
#102137

@hugovk
Copy link
Member

hugovk commented Feb 22, 2023

Thanks, that's looking good, I'll review it!

hugovk pushed a commit that referenced this issue Feb 22, 2023
@SectorCorruptor
gh-102135: Update turtle docs to rename wikipedia demo to rosette (#1…
8d46c7e 
…02137)
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 22, 2023
@SectorCorruptor @miss-islington
pythongh-102135: Update turtle docs to rename wikipedia demo to roset…
18160a2 
…te (pythonGH-102137)

(cherry picked from commit 8d46c7e)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Feb 22, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 22, 2023
@SectorCorruptor @miss-islington
pythongh-102135: Update turtle docs to rename wikipedia demo to roset…
bb2e93f 
…te (pythonGH-102137)

(cherry picked from commit 8d46c7e)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Feb 22, 2023
Merged
@hugovk
Copy link
Member

hugovk commented Feb 22, 2023

Thanks again for reporting and fixing this 🚀

@hugovk hugovk closed this as completed Feb 22, 2023
hugovk pushed a commit that referenced this issue Feb 22, 2023
@miss-islington @SectorCorruptor
[3.10] gh-102135: Update turtle docs to rename wikipedia demo to rose…
3e9fb1a 
…tte (GH-102137) (#102139)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>
miss-islington added a commit that referenced this issue Feb 22, 2023
@miss-islington
[3.11] gh-102135: Update turtle docs to rename wikipedia demo to rose…
528e91c 
…tte (GH-102137) (GH-102138)

(cherry picked from commit 8d46c7e)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>

Automerge-Triggered-By: GH:hugovk
@terryjreedy
Copy link
Member

Thanks for catching this. I changed the name 5 years ago and did not notice the reference in the doc.

carljm added a commit to carljm/cpython that referenced this issue Feb 23, 2023
@carljm
Merge branch 'main' into lockfreecp
b257a16 
* main: (76 commits)
  Fix syntax error in struct doc example (python#102160)
  pythongh-99108: Import MD5 and SHA1 from HACL* (python#102089)
  pythonGH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (python#102143)
  Few coverage nitpicks for the cmath module (python#102067)
  pythonGH-100982: Restrict `FOR_ITER_RANGE` to a single instruction to allow instrumentation. (pythonGH-101985)
  pythongh-102135: Update turtle docs to rename wikipedia demo to rosette (python#102137)
  pythongh-99942: python.pc on android/cygwin should link to libpython per configure.ac (pythonGH-100356)
  pythongh-95672 fix typo SkitTest to SkipTest (pythongh-102119)
  pythongh-101936: Update the default value of fp from io.StringIO to io.BytesIO (pythongh-102100)
  pythongh-102008: simplify test_except_star by using sys.exception() instead of sys.exc_info() (python#102009)
  pythongh-101903: Remove obsolete undefs for previously removed macros Py_EnterRecursiveCall and Py_LeaveRecursiveCall (python#101923)
  pythongh-100556: Improve clarity of `or` docs (python#100589)
  pythongh-101777: Make `PriorityQueue` docs slightly clearer (python#102026)
  pythongh-101965: Fix usage of Py_EnterRecursiveCall return value in _bisectmodule.c (pythonGH-101966)
  pythongh-101578: Amend exception docs (python#102057)
  pythongh-101961 fileinput.hookcompressed should not set the encoding value for the binary mode (pythongh-102068)
  pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078)
  pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012)
  pythongh-101566: Sync with zipp 3.14. (pythonGH-102018)
  pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589)
  ...
JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this issue Sep 10, 2024
@SectorCorruptor @JelleZijlstra
pythongh-102135: Update turtle docs to rename wikipedia demo to roset…
4b96fb0 
…te (python#102137)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hugovk @terryjreedy @SectorCorruptor