Skip to content
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

Mention, and emphasise, HTTPClient #276

Merged
merged 13 commits into from
Mar 26, 2020
Merged

Conversation

twm
Copy link
Contributor

@twm twm commented Mar 22, 2020

This is #129 merged forward.

cwaldbieser and others added 11 commits July 29, 2015 20:47
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.
Fixes this warning:

    ../CHANGELOG.rst:24: WARNING: 'any' reference target not found: treq.testing
@twm twm marked this pull request as ready for review March 23, 2020 04:37
@twm twm requested a review from a team March 25, 2020 04:26
Copy link

@moshez moshez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I am happy we are moving the "official recommendation" to a more explicit API.

One small suggestions, but looks ok to me!

docs/api.rst Outdated
@@ -6,6 +6,11 @@ This page lists all of the interfaces exposed by the `treq` package.
Making Requests
---------------

The :py:mod:`treq` module provides several shortcut functions for making
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would "convenience" be a better word here (and below) than "shortcut"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, that makes sense to me.

@twm twm merged commit aa8530a into twisted:master Mar 26, 2020
@twm twm deleted the 129-httpclient-docs branch March 26, 2020 06:39
@twm
Copy link
Contributor Author

twm commented Mar 26, 2020

Thank you for the review, @moshez!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants