[PR #7733/3b68b2f3 backport][3.9] Fix, update, and improve client exceptions documentation #7737
+42
−34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![patchback[bot]](https://avatars.githubusercontent.com/in/21488?s=60&v=4){kind=small}
## What do these changes do? In the *Hierarchy of exceptions* section of the *Client Reference* documentation: - Fix `ServerConnectionError` indentation, denoting that it subclasses `ClientConnectionError`, not `ClientOSError` - Fix `ServerFingerprintMismatch` indentation, denoting that it subclasses `ServerConnectionError`, not `ClientOSError` - Normalize the formatting so as to consistently use two, rather than three, spaces for indentation - Normalize the formatting so as to consistently include a blank newline between exceptions - Order exceptions alphabetically - Add `TooManyRedirects` - Add `UnixClientConnectorError` Also order the documentation of client exceptions alphabetically by hierarchy (cherry picked from commit 3b68b2f)
1 task
Codecov Report
@@ Coverage Diff @@
## 3.9 #7737 +/- ##
=======================================
Coverage 97.30% 97.30%
=======================================
Files 107 107
Lines 31910 31910
Branches 3729 3729
=======================================
Hits 31051 31051
Misses 654 654
Partials 205 205
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Dreamsorcerer
deleted the
patchback/backports/3.9/3b68b2f3abe8a9e554e4bbd8bcabb9847f364806/pr-7733
branch
xiangxli
pushed a commit
to xiangxli/aiohttp
that referenced
this pull request
Dec 4, 2023
…ient exceptions documentation (aio-libs#7737) **This is a backport of PR aio-libs#7733 as merged into master (3b68b2f).** In the *Hierarchy of exceptions* section of the *Client Reference* documentation: - Fix `ServerConnectionError` indentation, denoting that it subclasses `ClientConnectionError`, not `ClientOSError` - Fix `ServerFingerprintMismatch` indentation, denoting that it subclasses `ServerConnectionError`, not `ClientOSError` - Normalize the formatting so as to consistently use two, rather than three, spaces for indentation - Normalize the formatting so as to consistently include a blank newline between exceptions - Order exceptions alphabetically - Add `TooManyRedirects` - Add `UnixClientConnectorError` Also order the documentation of client exceptions alphabetically by hierarchy - [N/A] I think the code is well written - [N/A] Unit tests for the changes exist - [N/A] Documentation reflects the changes - [N/A ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt` * The format is <Name> <Surname>. * Please keep alphabetical order, the file is sorted by names. - [X] Add a new news fragment into the `CHANGES` folder * name it `<issue_id>.<type>` for example (588.bugfix) * if you don't have an `issue_id` change it to the pr id after creating the pr * ensure type is one of the following: * `.feature`: Signifying a new feature. * `.bugfix`: Signifying a bug fix. * `.doc`: Signifying a documentation improvement. * `.removal`: Signifying a deprecation or removal of public API. * `.misc`: A ticket has been closed, but it is not of interest to users. * Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files." Co-authored-by: Harmon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of PR #7733 as merged into master (3b68b2f).
What do these changes do?
In the Hierarchy of exceptions section of the Client Reference documentation:
ServerConnectionErrorindentation, denoting that it subclassesClientConnectionError, notClientOSErrorServerFingerprintMismatchindentation, denoting that it subclassesServerConnectionError, notClientOSErrorTooManyRedirectsUnixClientConnectorErrorAlso order the documentation of client exceptions alphabetically by hierarchy
Checklist
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange it to the pr id after creating the pr.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.