Update delete-by-query.asciidoc #37370
Conversation
colings86
added
>docs
|
Pinging @elastic/es-core-features |
| @@ -384,7 +384,7 @@ POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel | |||
| The task ID can be found using the <<tasks,tasks API>>. | |||
|
|
|||
| Cancellation should happen quickly but might take a few seconds. The task status | |||
| API above will continue to list the task until it is wakes to cancel itself. | |||
| API above will continue to list the task until the task is awaken to cancel itself. | |||
There was a problem hiding this comment.
Perhaps something like the following?
| API above will continue to list the task until the task is awaken to cancel itself. | |
| API above will continue to list the task until the task awakens to cancel itself. |
There was a problem hiding this comment.
Well, does the task awaken by itself ? And it wasn't clear for me which task is canceled: the _delete_by_query task or the cancel the _delete_by_query task... Perhaps the text could be explicit to avoid ambiguities.
There was a problem hiding this comment.
which task is awaken *
There was a problem hiding this comment.
Well, does the task awaken by itself?
Technically the task checks periodically to see whether it has been cancelled, and if so, stops executing.
And it wasn't clear for me which task is canceled: the _delete_by_query task or the cancel the _delete_by_query task... Perhaps the text could be explicit to avoid ambiguities.
The delete-by-query task is the one that stops when cancelled (with the check I mentioned above).
Perhaps we should clarify it to something like
"Cancellation should happen quickly but might take a few seconds. The task static API will continue to list the task until the delete by query task checks that it has been cancelled and terminates itself."
There was a problem hiding this comment.
Technically the task checks periodically to see whether it has been cancelled, and if so, stops executing.
Nice!
Perhaps we should clarify it to something like
"Cancellation should happen quickly but might take a few seconds. The task static API will continue to list the task until the delete by query task checks that it has been cancelled and terminates itself."
The task static API also lists the cancel task right ? What about:
"The task static API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself."
:)
There was a problem hiding this comment.
Commited the change in my branch, is it ok ?
Tried my best to clarify sentence on `_delete_by_query` docs.
Tried my best to clarify sentence on `_delete_by_query` docs.
Tried my best to clarify sentence on `_delete_by_query` docs.
Similar fix as elastic#37370.
Tried my best to clarify sentence on
_delete_by_querydocs.