Skip to content

GH-109975: Copyedit 3.13 What's New: Improved Modules#123132

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
Merged
AA-Turner merged 12 commits into from
Aug 24, 2024
Merged

GH-109975: Copyedit 3.13 What's New: Improved Modules #123132

AA-Turner merged 12 commits into from
Aug 24, 2024
+480 −355

Conversation

@AA-Turner
Copy link
Member

@AA-TurnerAA-Turner commented Aug 19, 2024•
edited
Loading

A copy-editing pass for improved modules. Next will be optimised modules. Sorry for the slight delay, I've been travelling.

Summary of changes (by theme):

  • Link module headings to their module
  • Reduce duplication by not listing the module name in cross-links
  • Provide links or references to concepts where appropriate
  • Word items by the intended change first, describing the implementation second, rather than vice-versa.
  • Remove double spaces, () in cross-reference roles, etc
  • General wording improvements

A

📚 Documentation preview 📚: https://cpython-previews--123132.org.readthedocs.build/en/123132/whatsnew/3.13.html#improved-modules

@AA-TurnerAA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Aug 19, 2024
@AA-TurnerAA-Turner requested review from Yhg1s and hugovkAugust 19, 2024 00:34
@bedevere-appbedevere-appbot mentioned this pull request Aug 19, 2024
Closed
hugovk
hugovk reviewed Aug 19, 2024
View reviewed changes
Doc/whatsnew/3.13.rst Outdated
(Contributed by Tian Gao in :gh:`118579`.)
* Add ability to move between chained exceptions during
post mortem debugging in :func:`~pdb.pm` using
the new ``exceptions [exc_number]`` command for Pdb.
Copy link
Member

@hugovkhugovkAug 19, 2024

Choose a reason for hiding this comment

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

Is this "Pdb" the class Pdb or module pdb or something else?

Copy link
MemberAuthor

@AA-TurnerAA-TurnerAug 20, 2024

Choose a reason for hiding this comment

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

I think it means the Pdb command-line, I've added a cross-reference which might help things, or we could add clarificatory words.

@AA-TurnerAA-Turner mentioned this pull request Aug 19, 2024
Merged
@AA-Turner
Copy link
MemberAuthor

AA-Turner commented Aug 21, 2024

Heading links all gone.

A

@AA-TurnerAA-Turner requested a review from hugovkAugust 21, 2024 23:45
hugovk
hugovk approved these changes Aug 22, 2024
View reviewed changes
Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@AA-TurnerAA-Turner merged commit 127660b into python:mainAug 24, 2024
@AA-TurnerAA-Turner deleted the docs/whatsnew/improved-modules branch August 24, 2024 13:32
@miss-islington-app
Copy link

miss-islington-appbot commented Aug 24, 2024

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-appbot commented Aug 24, 2024

Sorry, @AA-Turner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 127660bcdb28294c3817f955cabd85afb6828ffc 3.13

@miss-islington-app
Copy link

miss-islington-appbot commented Aug 24, 2024

Sorry, @AA-Turner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 127660bcdb28294c3817f955cabd85afb6828ffc 3.12

@AA-TurnerAA-Turner removed the needs backport to 3.12 only security fixes label Aug 24, 2024
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Aug 24, 2024
@AA-Turner@hugovk
[3.13]pythonGH-109975: Copyedit 3.13 What's New: Improved Modules (p…
713be75
…ythonGH-123132) (cherry picked from commit 127660b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-appbot commented Aug 24, 2024

GH-123292 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Aug 24, 2024
AA-Turner added a commit that referenced this pull request Aug 24, 2024
@AA-Turner@hugovk
[3.13]GH-109975: Copyedit 3.13 What's New: Improved Modules (GH-123132…
6587900
…) (#123292) (cherry picked from commit 127660b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

@Yhg1sYhg1sAwaiting requested review from Yhg1s

Assignees

@AA-TurnerAA-Turner

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AA-Turner@hugovk