Skip to content

Commit 7d9f952

Browse files
committed
Doc improvement
1 parent 21441ac commit 7d9f952

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

docs/source/superannotate.sdk.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@ ______
8484
.. autofunction:: superannotate.download_image_preannotations
8585
.. autofunction:: superannotate.upload_image_annotations
8686
.. autofunction:: superannotate.copy_image
87+
.. autofunction:: superannotate.copy_images
8788
.. autofunction:: superannotate.move_image
89+
.. autofunction:: superannotate.move_images
8890
.. autofunction:: superannotate.pin_image
8991
.. autofunction:: superannotate.assign_images
9092
.. autofunction:: superannotate.delete_image

superannotate/db/project_images.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,21 @@ def copy_images(
203203
copy_annotation_status=True,
204204
copy_pin=True
205205
):
206+
"""Copy images in bulk between folders in a project
207+
208+
:param source_project: project name or folder path (e.g., "project1/folder1")
209+
:type source_project: str
210+
:param destination_project: project name or folder path (e.g., "project1/folder2")
211+
:type destination_project: str
212+
:param image_names: image names. If None, all images from source project will be copied
213+
:type image: list of str
214+
:param include_annotations: enables annotations copy
215+
:type include_annotations: bool
216+
:param copy_annotation_status: enables annotations status copy
217+
:type copy_annotation_status: bool
218+
:param copy_pin: enables image pin status copy
219+
:type copy_pin: bool
220+
"""
206221
source_project, source_project_folder = get_project_and_folder_metadata(
207222
source_project
208223
)
@@ -270,6 +285,21 @@ def move_images(
270285
copy_annotation_status=True,
271286
copy_pin=True,
272287
):
288+
"""Move images in bulk between folders in a project
289+
290+
:param source_project: project name or folder path (e.g., "project1/folder1")
291+
:type source_project: str
292+
:param destination_project: project name or folder path (e.g., "project1/folder2")
293+
:type destination_project: str
294+
:param image_names: image names. If None, all images from source project will be moved
295+
:type image: list of str
296+
:param include_annotations: enables annotations copy
297+
:type include_annotations: bool
298+
:param copy_annotation_status: enables annotations status copy
299+
:type copy_annotation_status: bool
300+
:param copy_pin: enables image pin status copy
301+
:type copy_pin: bool
302+
"""
273303
source_project, source_project_folder = get_project_and_folder_metadata(
274304
source_project
275305
)

superannotate/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "4.1.0b7"
1+
__version__ = "4.1.0b8"

0 commit comments

Comments
 (0)