Skip to content

Commit 34213fc

Browse files
committed
image quality settings docs
1 parent 952ad41 commit 34213fc

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

superannotate/db/projects.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1579,8 +1579,8 @@ def set_project_settings(project, new_settings):
15791579
15801580
:param project: project name or metadata
15811581
:type project: str or dict
1582-
:param project: new settings list of dicts
1583-
:type project: list of dicts
1582+
:param new_settings: new settings list of dicts
1583+
:type new_settings: list of dicts
15841584
15851585
:return: updated part of project's settings
15861586
:rtype: list of dicts
@@ -1656,6 +1656,13 @@ def _set_project_default_image_quality_in_editor(project, quality):
16561656
def set_project_default_image_quality_in_editor(
16571657
project, image_quality_in_editor
16581658
):
1659+
"""Sets project's default image quality in editor setting.
1660+
1661+
:param project: project name or metadata
1662+
:type project: str or dict
1663+
:param image_quality_in_editor: new setting value, should be "original" or "compressed"
1664+
:type image_quality_in_editor: str
1665+
"""
16591666
if image_quality_in_editor == "compressed":
16601667
image_quality_in_editor = 60
16611668
elif image_quality_in_editor == "original":
@@ -1670,6 +1677,14 @@ def set_project_default_image_quality_in_editor(
16701677

16711678

16721679
def get_project_default_image_quality_in_editor(project):
1680+
"""Gets project's default image quality in editor setting.
1681+
1682+
:param project: project name or metadata
1683+
:type project: str or dict
1684+
1685+
:return: "original" or "compressed" setting value
1686+
:rtype: str
1687+
"""
16731688
image_quality_in_editor = _get_project_image_quality_in_editor(
16741689
project, None
16751690
)

0 commit comments

Comments
 (0)