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.

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

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

Merged
merged 12 commits into from
Aug 24, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Aug 19, 2024

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-Turner AA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Aug 19, 2024
@AA-Turner AA-Turner requested review from hugovk and Yhg1s August 19, 2024 00:34
Doc/whatsnew/3.13.rst Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
(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

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
Member Author

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.

Doc/whatsnew/3.13.rst Show resolved Hide resolved
@AA-Turner
Copy link
Member Author

Heading links all gone.

A

@AA-Turner AA-Turner requested a review from hugovk August 21, 2024 23:45
Copy link
Member

@hugovk hugovk 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-Turner AA-Turner merged commit 127660b into python:main Aug 24, 2024
23 checks passed
@AA-Turner AA-Turner deleted the docs/whatsnew/improved-modules branch August 24, 2024 13:32
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

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

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-Turner AA-Turner removed the needs backport to 3.12 bug and security fixes label Aug 24, 2024
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Aug 24, 2024
…ythonGH-123132)

(cherry picked from commit 127660b)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Aug 24, 2024

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

@bedevere-app bedevere-app bot 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
…) (#123292)

(cherry picked from commit 127660b)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants