gh-139533: fix refs to code without proper markups on turtledemo doc #139534
Conversation
bedevere-app
bot
added
docs
AA-Turner
added
needs backport to 3.13
| +------------------------+------------------------------+--------------------------------------+ | ||
| | Name | Description | Features | | ||
| +========================+==============================+======================================+ | ||
| | ``bytedesign`` | complex classical | :func:`tracer`, :func:`delay`, | |
There was a problem hiding this comment.
:mod: role seems to be more suitable for this case.
There was a problem hiding this comment.
For bytedesign? It is a file in a module, not a module. Since it has no documentation, the rendered result will be the same anyway. I guess :source:`bytedesign <Lib/turtledemo/bytedesign.py>` would make sense, but I think the current one is fine.
There was a problem hiding this comment.
It is a module in a package, isn't it?
However, I haven't thought about the effects of :mod: at a module without documentation. I like the idea of making it easier to access source code. As demonstration scripts, it is natural that people want to see the code, particularly in educational contexts where the turtle is widely used
There was a problem hiding this comment.
My suggestion about :mod: is also, although sticks (``) are used on variables/literals/code, :mod: is a bigger warning saying "don't translate it". This issue arose from a discussion on this point. Is there something to this case? A role that escapes the string from the translation process?
aureliobarbosa
force-pushed
the
doc_turtledemo_table_issues
branch
from
febfc34 to
a8985a9
Compare
|
Please don't force push, it makes reviewing more difficult. |
|
|
Nope, you just have to wait now. There is a long queue of PRs before this one I’m afraid. |
|
Thanks @aureliobarbosa for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
…o doc (pythonGH-139534) (cherry picked from commit c903d76) Co-authored-by: Marco Barbosa <[email protected]> pythongh-139533: fix refs to code without proper markups on turtledemo documentation
|
GH-141421 is a backport of this pull request to the 3.14 branch. |
…o doc (pythonGH-139534) (cherry picked from commit c903d76) Co-authored-by: Marco Barbosa <[email protected]> pythongh-139533: fix refs to code without proper markups on turtledemo documentation
|
GH-141422 is a backport of this pull request to the 3.13 branch. |
|
I went ahead and merged this as it is an improvement. They aren't documented modules so |
With my translator hat on, I agree. |
|
Thanks for the reviews @gpshead and @StanFromIreland. |
5 participants
gh-139533: fix refs to code without proper markups on turtledemo doc
Many references to scripts and functions on turtledemo module documentation do not use the proper reStructuredText markups used on this repo. This PR fixes them.
📚 Documentation preview 📚: https://cpython-previews--139534.org.readthedocs.build/