Mention, and emphasize, HTTPClient in the documentation
#129
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
Glyph pointed out that the various treq request functions (`treq.get()`, `treq.post()`, etc.) don't need to be modified. Instead, the documentation should suggest that you use a `treq.client.HTTPClient` instance directly if you need to customize its behavior. This reverts commit 972b84f.
…client.HTTPClient` is meant to be used.
Closed
|
This object is roughly analogous to request's |
|
@dreid That's a very good point. |
|
This would be useful to https://github.com/brettcannon/gidgethub/blob/master/gidgethub/treq.py |
|
What's blocking this now? Renaming the API might be an improvement but it doesn't seem like the best thing to block documenting the existing API on that. Once the documentation lands it will be trivial to update it to follow any renaming. |
|
@exarkun Really just the conflicts (and presumably a review); it looks like some other improvements have landed in the meanwhile, so the conflicts aren't totally trivial? |
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.
Rather than encouraging people to mess around with
agent=in the treq signature.This is a continuation of @cwaldbieser's work from #109 .