Skip to content

Commit 3981fd3

Browse files
committed
Docs update
1 parent 679f2be commit 3981fd3

File tree

2 files changed

+7
-19
lines changed

2 files changed

+7
-19
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ ________________________
1212
**Added**
1313

1414
- ``SAClient.copy_items/move_items`` method, added the ability to copy/move categories and duplicate strategies ("skip", "replace", "replace_annotations_only").
15+
1516
**Updated**
1617

1718
- Fixed `SAClient.get_annotations() To handle annotations that contain all UTF-8 characters.`

src/superannotate/lib/app/interface/sdk_interface.py

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2556,19 +2556,13 @@ def search_items(
25562556
If recursive=False=True, then only the project name is required.
25572557
:type project: str
25582558
2559-
:param name_contains: Returns those items, where the given string is found anywhere within an item’s name.
2559+
:param name_contains: returns those items, where the given string is found anywhere within an item’s name.
25602560
If None, all items returned, in accordance with the recursive=False parameter.
25612561
:type name_contains: str
25622562
2563-
:param annotation_status: if not None, filters items by annotation status. \n
2564-
Available statuses are::
2563+
:param annotation_status: returns items with the specified annotation status, which must match a predefined
2564+
status in the project workflow. If None, all items are returned.
25652565
2566-
* NotStarted
2567-
* InProgress
2568-
* QualityCheck
2569-
* Returned
2570-
* Completed
2571-
* Skipped
25722566
:type annotation_status: str
25732567
25742568
:param annotator_email: returns those items’ names that are assigned to the specified annotator.
@@ -3049,20 +3043,13 @@ def set_annotation_statuses(
30493043
annotation_status: NotEmptyStr,
30503044
items: Optional[List[NotEmptyStr]] = None,
30513045
):
3052-
"""Sets annotation statuses of items
3046+
"""Sets annotation statuses of items.
30533047
30543048
:param project: project name or folder path (e.g., “project1/folder1”).
30553049
:type project: str
30563050
3057-
:param annotation_status: annotation status to set. \n
3058-
Available statuses are::
3059-
3060-
* NotStarted
3061-
* InProgress
3062-
* QualityCheck
3063-
* Returned
3064-
* Completed
3065-
* Skipped
3051+
:param annotation_status: The desired status to set for the annotation.
3052+
This status should match one of the predefined statuses available in the project workflow.
30663053
:type annotation_status: str
30673054
30683055
:param items: item names. If None, all the items in the specified directory will be used.

0 commit comments

Comments
 (0)