Skip to content

[HttpClient] Document pre-conditions for HttpClient asynchronous behavior #13078

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

Closed
wants to merge 1 commit into from

Conversation

B-Galati
Copy link
Contributor

@B-Galati B-Galati commented Feb 8, 2020

@B-Galati B-Galati force-pushed the http-async-clarification branch from a40d6ab to ab7969c Compare February 8, 2020 13:01
@B-Galati B-Galati changed the title Document pre-conditions for HttpClient asynchronous behavior [HttpClient] Document pre-conditions for HttpClient asynchronous behavior Feb 8, 2020
@@ -116,6 +116,14 @@ immediately instead of waiting to receive the response::
This component also supports :ref:`streaming responses <http-client-streaming-responses>`
for full asynchronous applications.

.. caution::
Copy link
Member

@nicolas-grekas nicolas-grekas Feb 11, 2020

Choose a reason for hiding this comment

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

this is too early and too scary in the page :)
I would try to make the description more... descriptive.
We feel the stress when reading it, but there is nothing special here, this is normal operations. It needs to be better described of course.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree for the scary thing :D

Where do you think it would fit the best in the doc?
IMHO it should be mentioned ASAP.

Copy link
Contributor

Choose a reason for hiding this comment

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

What about adding a Troubleshooting headline + a subsection and mentioning not just the solution but also the WHY you came to this point?

@B-Galati
Copy link
Contributor Author

B-Galati commented Feb 11, 2020 via email

@nicolas-grekas
Copy link
Member

Troubleshooting might make sense to me as there are other behaviors that ppl didn't expect until I explained them on issues (e.g. some exceptions thrown when using for each.)

This section could collect those explanations.

(async works also with the native client, and with the amp one soon.)

@B-Galati
Copy link
Contributor Author

Troubleshooting might make sense to me as there are other behaviors that ppl didn't expect until I explained them on issues (e.g. some exceptions thrown when using for each.)

I would be glad to add them all in this PR. Would you have issue links that I could use?

(async works also with the native client, and with the amp one soon.)

Awesome!

@nicolas-grekas
Copy link
Member

@nicolas-grekas
Copy link
Member

Thanks, replaced by #13136

@B-Galati B-Galati deleted the http-async-clarification branch February 15, 2020 08:59
javiereguiluz added a commit that referenced this pull request Feb 15, 2020
…(nicolas-grekas)

This PR was merged into the 4.4 branch.

Discussion
----------

[HttpClient] better explain how to deal with exceptions

Replaces #13078 and #13134

Commits
-------

61cddf5 [HttpClient] better explain how to deal with exceptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants