Skip to content

Documentation says "The built-in exceptions listed below", but they are no longer just below that section #114967

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

Closed
HarryLHW opened this issue Feb 3, 2024 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@HarryLHW
Copy link
Contributor

HarryLHW commented Feb 3, 2024

Documentation

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. I suggest changing it to The built-in exceptions listed in the document....

Linked PRs

@HarryLHW HarryLHW added the docs Documentation in the Doc dir label Feb 3, 2024
@HarryLHW HarryLHW changed the title Documentation says "The built-in exceptions listed below", but they are no longer under that section Documentation says "The built-in exceptions listed below", but they are no longer just below that section Feb 3, 2024
@terryjreedy
Copy link
Member

You are interpreting 'below' a little too narrowly. 'in this document' is also ambiguous and too broad. I considered closing this, however, I think 'listed in this chapter' should be clearer than either.

terryjreedy added a commit that referenced this issue Feb 5, 2024
…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]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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]>
terryjreedy added a commit that referenced this issue 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 issue 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 issue 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
Projects
None yet
Development

No branches or pull requests

2 participants