This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Turtle Documentation - Contents Hyperlink conflict
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Harry-Lees, docs@python, lukasz.langa, miss-islington, ray_giraffe
Priority: normal Keywords: easy, patch

Created on 2021-07-28 09:31 by ray_giraffe, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 27592 merged Harry-Lees, 2021-08-04 15:15
PR 27594 merged miss-islington, 2021-08-04 17:47
PR 27595 merged miss-islington, 2021-08-04 17:47
Messages (3)
msg398361 - (view) Author: Ray Kinane (ray_giraffe) Date: 2021-07-28 09:31
In the Turtle module,
there are 2 methods named "clear",
one for turtle objects and one for screen objects.

In the Turtle module documentation, 
in the contents section, 
in the "Turtle methods" section, 
under "More drawing control"
the clear() method hyperlink 
does not point to the correct section in the article.
It points to the section for the clear method for screen objects.

There is another identical hyperlink issue in the same article due to 2 methods with the same name: "reset"
msg398899 - (view) Author: Harry (Harry-Lees) * Date: 2021-08-04 14:24
The conflict comes from the fact that the documentation is written from the perspective of the procedure-oriented interface

"All methods of TurtleScreen/Screen also exist as functions, i.e. as part of the procedure-oriented interface"

The conflict in the documentation comes from the fact that there is a conflict in the code as-well. The way the conflict is resolved in the code is that:

"This TurtleScreen method is available as a global function only under the name clearscreen. The global function clear is a different one derived from the Turtle method clear."

I propose that we noindex the TurtleScreen.clear() method, and index the Turtle.clear() method instead which more accurately reflects the behaviour of the turtle module itself. A link to the TurtleScreen.clear() method will still be available through its alias TurtleScreen.clearscreen().
msg398927 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-04 18:15
Thanks, Harry! ✨ 🍰 ✨
Date User Action Args
2022-04-11 14:59:48adminsetgithub: 88923
2021-08-04 18:15:58lukasz.langasetstatus: open -> closed

versions: + Python 3.9, Python 3.10
nosy: + lukasz.langa

messages: + msg398927
resolution: fixed
stage: patch review -> resolved
2021-08-04 17:47:57miss-islingtonsetpull_requests: + pull_request26096
2021-08-04 17:47:50miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request26095
2021-08-04 15:15:55Harry-Leessetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request26093
2021-08-04 14:24:11Harry-Leessetnosy: + Harry-Lees
messages: + msg398899
2021-07-31 20:22:39eric.araujosetkeywords: + easy
stage: needs patch
type: enhancement -> behavior
versions: - Python 3.6, Python 3.7, Python 3.8, Python 3.9, Python 3.10
2021-07-28 09:31:01ray_giraffecreate