Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-139533: fix refs to code without proper markups on turtledemo doc#139534

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

@aureliobarbosa
Copy link
Contributor

@aureliobarbosaaureliobarbosa commentedOct 3, 2025•
edited by github-actionsbot
Loading

gh-139533: fix refs to code without proper markups on turtledemo doc

Many references to scripts and functions onturtledemo module documentation do not use the properreStructuredText markups used on this repo. This PR fixes them.

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

adorilson reacted with heart emoji
+------------------------+------------------------------+--------------------------------------+
| Name| Description| Features|
+========================+==============================+======================================+
|``bytedesign``| complex classical|:func:`tracer`,:func:`delay`,|
Copy link
Contributor

Choose a reason for hiding this comment

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

:mod: role seems to be more suitable for this case.

Choose a reason for hiding this comment

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

Forbytedesign? 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.

gpshead reacted with thumbs up emoji
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor

@adorilsonadorilsonOct 3, 2025•
edited
Loading

Choose a reason for hiding this comment

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

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?

@aureliobarbosaaureliobarbosaforce-pushed thedoc_turtledemo_table_issues branch fromfebfc34 toa8985a9CompareOctober 3, 2025 15:42
@StanFromIreland
Copy link
Member

Please don't force push, it makes reviewing more difficult.

aureliobarbosa reacted with thumbs up emoji

@aureliobarbosa
Copy link
ContributorAuthor

Please don't force push, it makes reviewing more difficult.
Sorry for the force push. Is there anything else to be done on my side?

@StanFromIreland
Copy link
Member

Nope, you just have to wait now. There is a long queue of PRs before this one I’m afraid.

aureliobarbosa reacted with thumbs up emoji

@gpsheadgpshead merged commitc903d76 intopython:mainNov 11, 2025
65 checks passed
@miss-islington-app
Copy link

Thanks@aureliobarbosa for the PR, and@gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@github-project-automationgithub-project-automationbot moved this fromTodo toDone inDocs PRsNov 11, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestNov 11, 2025
…o doc (pythonGH-139534)(cherry picked from commitc903d76)Co-authored-by: Marco Barbosa <aureliobarbosa@gmail.com>pythongh-139533: fix refs to code without proper markups on turtledemo documentation
@bedevere-app
Copy link

GH-141421 is a backport of this pull request to the3.14 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.14bugs and security fixes labelNov 11, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestNov 11, 2025
…o doc (pythonGH-139534)(cherry picked from commitc903d76)Co-authored-by: Marco Barbosa <aureliobarbosa@gmail.com>pythongh-139533: fix refs to code without proper markups on turtledemo documentation
@bedevere-app
Copy link

GH-141422 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelNov 11, 2025
@gpshead
Copy link
Member

I went ahead and merged this as it is an improvement. They aren't documented modules so:mod: could imply the wrong thing. Use of (``) feels like it should already be sufficient to indicate "this is a literal used in code somehow - do not translate it" to people or tooling doing translation to me, but if the docs folks and translators settle on something specific for that, followup issues/PRs can address it.

gpshead pushed a commit that referenced this pull requestNov 11, 2025
…mo doc (GH-139534) (#141422)gh-139533: fix refs to code without proper markups on turtledemo doc (GH-139534)(cherry picked from commitc903d76)gh-139533: fix refs to code without proper markups on turtledemo documentationCo-authored-by: Marco Barbosa <aureliobarbosa@gmail.com>
gpshead pushed a commit that referenced this pull requestNov 11, 2025
…mo doc (GH-139534) (#141421)gh-139533: fix refs to code without proper markups on turtledemo doc (GH-139534)(cherry picked from commitc903d76)gh-139533: fix refs to code without proper markups on turtledemo documentationCo-authored-by: Marco Barbosa <aureliobarbosa@gmail.com>
@StanFromIreland
Copy link
Member

Use of (``) feels like it should already be sufficient to indicate

With my translator hat on, I agree.

@aureliobarbosaaureliobarbosa deleted the doc_turtledemo_table_issues branchNovember 11, 2025 20:20
@aureliobarbosa
Copy link
ContributorAuthor

Thanks for the reviews@gpshead and@StanFromIreland.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@gpsheadgpsheadgpshead approved these changes

@terryjreedyterryjreedyAwaiting requested review from terryjreedy

@StanFromIrelandStanFromIrelandAwaiting requested review from StanFromIreland

+1 more reviewer

@adorilsonadorilsonadorilson left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@aureliobarbosa@StanFromIreland@gpshead@adorilson@AA-Turner
[8]ページ先頭
©2009-2025 Movatter.jp