generated from explainers-by-googlers/template
-
Notifications
You must be signed in to change notification settings - Fork 9
Support multiple labels #31
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
Open
QueenieZqq
wants to merge
1
commit into
main
Choose a base branch
from
multiple-labels
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,7 +9,7 @@ Web applications can also benefit from such proofreading capability. This propos | |||||
|
|
||||||
|
|
||||||
| 1. Error Correction: Correct input text by the user | ||||||
| 2. Error Labeling: For each correction made to each error in the input text, label the error type (e.g. spelling, punctuation, etc.) | ||||||
| 2. Error Labeling: For each correction made to each error in the input text, label the error type(s) (e.g. spelling, punctuation, etc.) | ||||||
| 3. Error Explanation: Annotates each error with a plain language explanation | ||||||
|
|
||||||
| Note that Labeling & Explanation are independent features that can be either added or dropped. | ||||||
|
|
@@ -50,7 +50,7 @@ const proofreader = await Proofreader.create({ | |||||
| const corrections = await proofreader.proofread("I seen him yesterday at the store, and he bought two loafs of bread."); | ||||||
| ``` | ||||||
|
|
||||||
| `proofread()` corrects the input text and returns a list of corrections made. Additional proofreading features can be configured using includeCorrectionTypes and `includeCorrectionExplanations`. When `includeCorrectionTypes` is set to `true`, `proofread()` will provide an error type label for each correction made to each error. When `includeCorrectionExplanations` is set to `true`, `proofread()` will provide an annotation for each error with a plain language explanation. | ||||||
| `proofread()` corrects the input text and returns a list of corrections made. Additional proofreading features can be configured using includeCorrectionTypes and `includeCorrectionExplanations`. When `includeCorrectionTypes` is set to `true`, `proofread()` will provide the error type labels associated for each correction made to each error. When `includeCorrectionExplanations` is set to `true`, `proofread()` will provide an annotation for each error with a plain language explanation. | ||||||
|
|
||||||
| Detailed design for the corrections output is [discussed later](#proofreading-correction-output). | ||||||
|
|
||||||
|
|
@@ -197,7 +197,7 @@ dictionary ProofreadCorrection { | |||||
| unsigned long long startIndex; | ||||||
| unsigned long long endIndex; | ||||||
| DOMString correction; | ||||||
| CorrectionType type; // exists if proofreader.includeCorrectionTypes === true | ||||||
| sequence<CorrectionType> type; // exists if proofreader.includeCorrectionTypes === true | ||||||
| DOMString explanation; // exists if proofreader.includeCorrectionExplanations === true | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -206,6 +206,14 @@ enum CorrectionType { "spelling", "punctuation", "capitalization", "preposition" | |||||
|
|
||||||
| `type` only exists when the proofreader object is configured with `includeCorrectionTypes = true`, while `explanation` only exists when the proofreader object is configured with `includeCorrectionExplanations = true`. | ||||||
|
|
||||||
| Each correction could be associated with mutliple correction type labels. For example: | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ```js | ||||||
| const original_text = "`thatd` a good amt of time!!! !" // `thatd` is the text to be corrected | ||||||
| const proofread_text = "`That's` a good amount of time!" // `That's` is the corrected text | ||||||
| ``` | ||||||
| where the correction from "thatd" to "That's" contains three types of correction - "Captilization", "Spelling" and "Punctuation". When there's only one label, the sequence will be of size 1. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| Not all correction types here will be applicable to all languages, and in the future we might propose more specific correction types. The generic catch-all type, if no more-specific type matches, is `"grammar"`. | ||||||
|
|
||||||
| To get an error in the input, use `input.substring(startIndex, endIndex)`. Corrections in the `corrections` list will be organized in ascending order based on the `startIndex` of the correction. | ||||||
|
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the "Full API surface in Web IDL" section below as well.