Skip to content

Documented $response->getInfo('canceled') #12526

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 23, 2019

Conversation

Toflar
Copy link
Contributor

@Toflar Toflar commented Oct 21, 2019

Documented the new canceled information introduced in symfony/symfony#34044.

Reading the docs, I wonder if we need to catch any Throwable and also set canceled to true @nicolas-grekas?

Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

(after minor typo is fixed)

@@ -417,6 +417,9 @@ Or throw an exception from a progress callback::
The exception will be wrapped in an instance of ``TransportExceptionInterface``
and will abort the request.

In case the response was canceled using ``$response->cancel()``,
``$response->getInfo('canceled')`` will return `true`.
Copy link
Member

Choose a reason for hiding this comment

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

double backticks around true

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh man...

@Toflar
Copy link
Contributor Author

Toflar commented Oct 21, 2019

Fixed, sorry.

@javiereguiluz javiereguiluz added this to the 4.4 milestone Oct 22, 2019
@javiereguiluz
Copy link
Member

@OskarStark note for mergers: we must add versionadded:: 4.4 while merging this. Thanks!

@OskarStark OskarStark force-pushed the response-canceled-info branch from f366d19 to 71cff04 Compare October 23, 2019 08:30
@OskarStark
Copy link
Contributor

Thank you Yanick.

OskarStark added a commit that referenced this pull request Oct 23, 2019
This PR was squashed before being merged into the 4.4 branch (closes #12526).

Discussion
----------

Documented $response->getInfo('canceled')

Documented the new `canceled` information introduced in symfony/symfony#34044.

Reading the docs, I wonder if we need to catch any `Throwable` and also set `canceled` to `true` @nicolas-grekas?

Commits
-------

71cff04 Documented $response->getInfo('canceled')
@OskarStark OskarStark merged commit 71cff04 into symfony:4.4 Oct 23, 2019
@OskarStark
Copy link
Contributor

I added the missing versionadded in c82a7e1

@Toflar Toflar deleted the response-canceled-info branch October 23, 2019 08:37
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.

5 participants