Updated cancel tasks API reference #3080
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes meilisearch#2818 Currently cancel task API reference incorrectly mentions that even completed tasks can be cancelled. Updated the documentation to rectify that. Additionally added clarifications for which dates can be used for cancelling tasks. Things to check: 1. Does the suggested change clearly convey the dates that can be used for task cancellation criteria? 2. Is there any ambiguity left here for the first time reader that needs addressal?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2818
Currently cancel tasks API reference incorrectly mentions that even completed tasks can be cancelled. Updated the documentation to rectify that. Additionally added clarifications for which dates can be used for cancelling tasks.
Things to check:
enqueuedAtandstartedAtare timestamps as per the documentation. Would writing it as timestamps contradict with the similar usage of dates everywhere else in the documentation?