Skip to content

[HttpClient] fix documentation of retry_failed #19854

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
Amunak opened this issue May 2, 2024 · 1 comment
Closed

[HttpClient] fix documentation of retry_failed #19854

Amunak opened this issue May 2, 2024 · 1 comment

Comments

@Amunak
Copy link

Amunak commented May 2, 2024

The documentation for retry_failed / RetryableHttpClient implies that this feature is enabled by default:

Sometimes, requests fail because of network issues or temporary server errors. Symfony's HttpClient allows to retry failed requests automatically using the retry_failed option.

By default, failed requests are retried up to 3 times, [...]

What does the "by default" here refer to? Because by default it's certainly not enabled. It should be clarified.

The framework configuration hints more that this isn't the case:

By enabling the optional retry_failed configuration, the HTTP client service will automatically retry failed HTTP requests.

I feel like the documentation here is in general kinda confusing, since it's split between two places, worded differently and there is some information in one place, some in the other, and some in both. The result is confusing and to me (at least the first instance) implies that it's enabled by default.

@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Jun 19, 2024
@xabbuh xabbuh removed the hasPR A Pull Request has already been submitted for this issue. label Jul 30, 2024
@xabbuh xabbuh reopened this Jul 30, 2024
@nicolas-grekas
Copy link
Member

I think we can close this issue, I don't see much more to say after reading the current doc.

@xabbuh xabbuh closed this as completed May 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy