Skip to content

[HttpClient] Add documentation for Retryable client #14253

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

Merged
merged 1 commit into from
Oct 2, 2020

Conversation

jderusse
Copy link
Member

@jderusse jderusse commented Sep 17, 2020

Fixes #14252, #14317

@jderusse jderusse changed the title Add documentation for Retryable client [HttpClient] Add documentation for Retryable client Sep 17, 2020
$client = new RetryableHttpClient(HttpClient::create());

The ``RetryableHttpClient`` uses a
:class:`Symfony\\Component\\HttpClient\\Retry\\RetryDeciderInterface` to
Copy link
Member Author

Choose a reason for hiding this comment

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

Do you think we need a section to explain how user can implement their own Decider and BackOff ?

Copy link
Member

Choose a reason for hiding this comment

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

It's not necessary because we no longer document components on its own, but when used inside a Symfony app. Thanks!

@javiereguiluz javiereguiluz added this to the 5.2 milestone Oct 2, 2020
@javiereguiluz javiereguiluz merged commit 2fed71a into symfony:master Oct 2, 2020
@javiereguiluz
Copy link
Member

Jérémy, thanks a lot for implementing this feature and contributing its docs. We've just merged. We did some rewords to explain first the integration with Symfony and we added the versionadded directives. We also removed all the "XXX option can't be set if you also set YYY option" because that will be displayed by the application in easy to understand error messages, so there's no need to complicate the docs with that. Thanks!

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.

[HttpClient] Added RetryHttpClient
4 participants