Update Docs Occurrences of requests.Response#199
Merged
Conversation
Replace all occurrences of requests.Reponse with httpx.Response. Also do some minor documentation updates, including some formatting and removal of example texts. Include :special-members: for the API interface, as the auth-parameter will be documented in the __init__ method, and the docs of the context manager for async were not published yet. Additionally, remove the intersphinx reference to requests. Unfortunately, httpx does not have an inventory file (see also [1]) [1]: encode/httpx#3091 Closes gdcc#198.
JR-1991
approved these changes
Jul 19, 2024
Member
JR-1991
left a comment
There was a problem hiding this comment.
Looks good to me, thanks! Approved.
This file contains hidden or 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
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.
Replace all occurrences of requests.Reponse with httpx.Response.
Also do some minor documentation updates, including some formatting and removal of example texts.
Include :special-members: for the API interface, as the auth-parameter will be documented in the init method, and the docs of the context manager for async were not published yet.
Additionally, remove the intersphinx reference to requests. Unfortunately, httpx does not have an inventory file (see also encode/httpx#3091)
Describe your environment
On host:
Inside container:
Follow best practices
Describe the PR
Closes #ISSUE_NUMBERto the end of this pull requestTesting
Commits
Closes #ISSUE_NUMBERin your commit messages to auto-close the issue that it fixes (if such).Others
Documentation contribution
:class:\...`` which I did not resolve in this PR.Code contribution
Closes #198