Merge pull request #334 from Labelbox/jtso/update_docstrings

updates to documentation. also, Line should only be 2 or more Points

Author: jtsodapop

labelbox/data/annotation_types/classification/classification.py

@@ -29,18 +29,30 @@ class ClassificationAnswer(FeatureSchema):
 
 
 class Radio(BaseModel):
-    """ A classification with only one selected option allowed """
+    """ A classification with only one selected option allowed
+    
+    >>> Radio(answer = ClassificationAnswer(name = "dog"))
+
+    """
     answer: ClassificationAnswer
 
 
 class Checklist(_TempName):
-    """ A classification with many selected options allowed """
+    """ A classification with many selected options allowed
+
+    >>> Checklist(answer = [ClassificationAnswer(name = "cloudy")])
+
+    """
     name: Literal["checklist"] = "checklist"
     answer: List[ClassificationAnswer]
 
 
 class Text(BaseModel):
-    """ Free form text """
+    """ Free form text
+
+    >>> Text(answer = "some text answer") 
+
+    """
     answer: str
 
 

labelbox/data/annotation_types/data/text.py

@@ -9,7 +9,14 @@
 
 class TextData(BaseData):
     """
-    Represents text data
+    Represents text data. Requires arg file_path, text, or url
+
+    >>> TextData(text="") 
+
+    Args:
+        file_path (str)
+        text (str)
+        url (str)
     """
     file_path: Optional[str] = None
     text: Optional[str] = None

labelbox/data/annotation_types/geometry/line.py

@@ -3,6 +3,7 @@
 import geojson
 import numpy as np
 import cv2
+from pydantic import validator
 
 from .point import Point
 from .geometry import Geometry
@@ -14,6 +15,8 @@ class Line(Geometry):
     Args:
         points (List[Point]): A list of `Point` geometries
 
+    >>> Line(points = [Point(x=3,y=4), Point(x=3,y=5)])
+
     """
     points: List[Point]
 
@@ -47,3 +50,12 @@ def draw(self,
                              False,
                              color=color,
                              thickness=thickness)
+
+    @validator('points')
+    def is_geom_valid(cls, points):
+        if len(points) < 2:
+            raise ValueError(
+                f"A line must have at least 2 points to be valid. Found {points}"
+            )
+
+        return points