Skip to content

gh-114967: Fix "Built-in Exceptions" documentation ambiguous wording #114968

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

Merged
merged 2 commits into from
Feb 5, 2024

Conversation

HarryLHW
Copy link
Contributor

@HarryLHW HarryLHW commented Feb 3, 2024

In the documentation of "Built-in Exceptions", the second paragraph states The built-in exceptions listed below can be generated by the interpreter or built-in functions. Because of the new sections "Exception context" and "Inheriting from built-in exceptions" were introduced in Python 3.9, the word "below" became ambiguous. Change 'below' to 'in this chapter'.


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

@ghost
Copy link

ghost commented Feb 3, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@HarryLHW
Copy link
Contributor Author

HarryLHW commented Feb 3, 2024

Sorry about the force-push. I mistakenly used the wrong email.

@terryjreedy
Copy link
Member

See #114967 (comment). Let's see if anyone else comments.

@HarryLHW
Copy link
Contributor Author

HarryLHW commented Feb 4, 2024

See #114967 (comment). Let's see if anyone else comments.

Thank you :)

@terryjreedy terryjreedy added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 5, 2024
@terryjreedy terryjreedy merged commit 750489c into python:main Feb 5, 2024
@miss-islington-app
Copy link

Thanks @HarryLHW for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 5, 2024
…rding (pythonGH-114968)

Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 750489c)

Co-authored-by: HarryLHW <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 5, 2024

GH-115033 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 5, 2024
…rding (pythonGH-114968)

Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 750489c)

Co-authored-by: HarryLHW <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 5, 2024
@bedevere-app
Copy link

bedevere-app bot commented Feb 5, 2024

GH-115034 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 5, 2024
terryjreedy added a commit that referenced this pull request Feb 5, 2024
…ording (GH-114968) (#115034)

Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------
(cherry picked from commit 750489c)
Co-authored-by: HarryLHW <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
terryjreedy added a commit that referenced this pull request Feb 5, 2024
…ording (GH-114968) (#115033)

Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------

(cherry picked from commit 750489c)
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: HarryLHW <[email protected]>
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
…rding (python#114968)

Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------
Co-authored-by: Terry Jan Reedy <[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