Add docstring for TranslationResult class

cr2007 · Jun 28, 2024 · 25d8638 · 25d8638
1 parent ee7d7b3
commit 25d8638
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/cambai/__init__.py b/cambai/__init__.py
@@ -238,6 +238,12 @@ class ExtendedTranslationData(BasicTranslationData, total=False):
     gender:    Optional[int]
 
 class TranslationResult(TypedDict):
+    """
+    Represents the result of a translation operation.
+
+    Attributes:
+        text (str): The translated text.
+    """
     text: str
 
 # ------------------------------------------------------------------------------------------------ #