Correct/add destroy information on AI API pages #41712
Merged
Conversation
This file contains hidden or 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
github-actions
bot
added
Content:WebAPI
Contributor
nathanmemmott
left a comment
nathanmemmott
left a comment
There was a problem hiding this comment.
Thank you this looks good to me with one comment!
| - : An {{domxref("AbortSignal")}} object instance, which allows the `create()` operation to be aborted via the associated {{domxref("AbortController")}}. | ||
| - : An {{domxref("AbortSignal")}} object instance, which allows a `create()` operation to be aborted via the associated {{domxref("AbortController")}}. The exact effect is dependant on when {{domxref("AbortController.abort()")}} is called: | ||
| - If `abort()` is called before the `create()` promise resolves, the `create()` operation is cancelled. | ||
| - If `abort()` is called after the `create()` promise fulfills, it has the same effect as calling {{domxref("LanguageDetector.destroy()")}}: The resources assigned to the resulting `LanguageDetector` instance are released, and any further language detection activity will fail. |
There was a problem hiding this comment.
any further language detection activity will fail.
Here and elsewhere, I wonder if we should explain what this means? That ongoing calls will reject, as well as any further calls.
Contributor
Author
There was a problem hiding this comment.
Thanks, @nathanmemmott, this is a good point. I have spelled out explicitly what this means on the destroy() pages, and the create() page signal descriptions. I don't think I need to say more on the summary pages, as it is easy to click through to one of the ref pages if you want to know more.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
As per #41610, the information on our AI API documentation pages relating to
destroy()/abort()is not accurate. This PR aims to fix this issue.cc @nathanmemmott. Can you give this a tech review?
Motivation
Additional details
Related issues and pull requests
Fixes #41610