Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[PR aio-libs#7733/3b68b2f3 backport][3.9] Fix, update, and improve cl…
…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]>
- Loading branch information