Add doc strings to Identifiable / Identifiables

Author: Val Brodsky

labelbox/schema/identifiable.py

@@ -3,6 +3,9 @@
 
 
 class Identifiable(ABC):
+    """
+    Base class for any object representing a unique identifier.
+    """
 
     def __init__(self, key: str):
         self._key = key
@@ -22,8 +25,14 @@ def __str__(self):
 
 
 class UniqueId(Identifiable):
+    """
+    Represents a unique, internally generated id.
+    """
     pass
 
 
 class GlobalKey(Identifiable):
+    """
+    Represents a user generated id.
+    """
     pass

labelbox/schema/identifiables.py

@@ -3,13 +3,24 @@
 
 
 class IdType(str, Enum):
+    """
+    The type of id used to identify a data row.
+    Currently supported types are:
+        - DataRowId: The id assigned to a data row by Labelbox.
+        - GlobalKey: The id assigned to a data row by the user.
+    """
     DataRowId = "UID"
     GlobalKey = "GLOBAL_KEY"
 
 
 class Identifiables:
 
     def __init__(self, iterable, id_type: IdType):
+        """
+        Args:
+            iterable: Iterable of ids (unique or global keys)
+            id_type: The type of id used to identify a data row.
+        """
         self._iterable = iterable
         self._index = 0
         self._id_type = id_type
@@ -19,12 +30,18 @@ def __iter__(self):
 
 
 class UniqueIds(Identifiables):
+    """
+    Represents a collection of unique, internally generated ids.
+    """
 
     def __init__(self, iterable: List[str]):
         super().__init__(iterable, IdType.DataRowId)
 
 
 class GlobalKeys(Identifiables):
+    """
+    Represents a collection of user generated ids.
+    """
 
     def __init__(self, iterable: List[str]):
         super().__init__(iterable, IdType.GlobalKey)