Skip to content

Commit 17e0ba5

Browse files
committed
Update docstrings
1 parent 2834b52 commit 17e0ba5

2 files changed

Lines changed: 27 additions & 9 deletions

File tree

pytest.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ minversion = 3.7
33
log_cli=true
44
python_files = test_*.py
55
;pytest_plugins = ['pytest_profiling']
6-
;addopts = -n 6 --dist loadscope
6+
addopts = -n 6 --dist loadscope

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

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1999,6 +1999,7 @@ def get_annotation_class(
19991999
project="classes",
20002000
annotation_class="Example_class"
20012001
)
2002+
20022003
Response Example:
20032004
::
20042005
@@ -2074,19 +2075,36 @@ def update_annotation_class(
20742075
:type name: str
20752076
20762077
:param attribute_groups: The full list of attribute groups for the class.
2078+
20772079
Each attribute group may contain:
20782080
2079-
- id (optional, required for existing groups)
2080-
- group_type (required): "radio", "checklist", "text", "numeric", or "ocr"
2081-
- name (required)
2082-
- isRequired (optional)
2083-
- default_value (optional)
2084-
- attributes (required, list)
2081+
::
2082+
2083+
* id (optional, required for existing groups)
2084+
* group_type (required)
2085+
* name (required)
2086+
* isRequired (optional)
2087+
* default_value (optional)
2088+
* attributes (list, required for Single and Multiple selection)
20852089
20862090
Each attribute may contain:
2091+
::
2092+
2093+
* id (optional, required for existing attributes)
2094+
* name (required)
2095+
2096+
The values for the group_type key are:
2097+
::
2098+
2099+
* radio (Single selection)
2100+
* checklist (Multiple selection)
2101+
* text (Text input)
2102+
* numeric (Numeric input)
2103+
* ocr (OCR input)
2104+
2105+
The ocr key is only available for Vector projects.
2106+
20872107
2088-
- id (optional, required for existing attributes)
2089-
- name (required)
20902108
20912109
:type attribute_groups: list of dicts
20922110

0 commit comments

Comments
 (0)