Skip to content

Commit

Permalink
docs: Rename review actions (#6728)
Browse files Browse the repository at this point in the history
Co-authored-by: caitlinwheeless <[email protected]>
  • Loading branch information
caitlinwheeless and caitlinwheeless authored Nov 27, 2024
1 parent b2b4c80 commit 8d41917
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/source/guide/project_settings_lse.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,12 @@ When a reviewer clicks **Reject**, the annotation is not reassigned back to the
Reviewers see the following options:

* **Accept**
* **Reject** -- When selected, the annotation is rejected and skipped.
* **Remove** -- When selected, the annotation is rejected and removed from the labeling queue.
* **Requeue** -- When selected, the annotation is rejected and then reassigned back to the annotator.

For example, a reviewer might decide to requeue an annotation that is nearly correct but just needs a slight change. However, an annotation with numerous errors may be easier to simply reject entirely and remove from the queue.

Note that when you click **Reject**, the annotation is also marked as cancelled/skipped. This is reflected in various metrics (for example, Data Manager columns and dashboards), and differentiates between the two rejection actions in the API with `was_cancelled: true`.
Note that when you click **Remove**, the annotation is also marked as cancelled/skipped. This is reflected in various metrics (for example, Data Manager columns and dashboards), and differentiates between the two rejection actions in the API with `was_cancelled: true`.

</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guide/release_notes/onprem/2.17.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Helm Chart version: 1.6.3

There is a new option on the **Review** page of the project settings: **Allow reviewer to choose: Requeue or Remove**.

When enabled, reviewers will see two reject options for an annotation: **Reject** (reject and remove the annotation from the queue) and **Requeue** (reject and then requeue the annotation).
When enabled, reviewers will see two reject options for an annotation: **Remove** (reject and remove the annotation from the queue) and **Requeue** (reject and then requeue the annotation).

This is useful for situations in which some annotations are incorrect or incomplete, but are acceptable with some fixes. In those cases, it may be more useful to send the task back to the annotator. In other cases, where the annotation is far from correct, it is better to remove it entirely.

Expand Down
Binary file modified docs/themes/v2/source/images/releases/2_17_0_review_actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d41917

Please sign in to comment.