style: add docstrings

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>

Author: ktro2828

t4_devkit/sanity/result.py

@@ -15,17 +15,22 @@
 
 
 class Status(str, Enum):
+    """Status of a report."""
+
     SUCCESS = "SUCCESS"
     FAILURE = "FAILURE"
     SKIPPED = "SKIPPED"
 
     def is_success(self) -> bool:
+        """Check if the status is success."""
         return self == Status.SUCCESS
 
     def is_failure(self) -> bool:
+        """Check if the status is failure."""
         return self == Status.FAILURE
 
     def is_skipped(self) -> bool:
+        """Check if the status is skipped."""
         return self == Status.SKIPPED
 
 
@@ -34,6 +39,16 @@ def is_skipped(self) -> bool:
 
 @define
 class Report:
+    """A report for a rule.
+
+    Attributes:
+        id (RuleID): The ID of the rule.
+        name (RuleName): The name of the rule.
+        description (str): The description of the rule.
+        status (Status): The status of the report.
+        reasons (list[Reason] | None): The list of reasons for the report if the report is a failure or skipped.
+    """
+
     id: RuleID
     name: RuleName
     description: str
@@ -73,12 +88,29 @@ def make_failure(id: RuleID, name: RuleName, description: str, reasons: list[Rea
 
 @define
 class SanityResult:
+    """The result of a Sanity check.
+
+    Attributes:
+        dataset_id (str): The ID of the dataset.
+        version (str | None): The version of the dataset.
+        reports (list[Report]): The list of reports.
+    """
+
     dataset_id: str
     version: str | None
     reports: list[Report]
 
     @classmethod
     def from_context(cls, context: SanityContext, reports: list[Report]) -> Self:
+        """Create a SanityResult from a SanityContext and a list of reports.
+
+        Args:
+            context (SanityContext): The SanityContext to use.
+            reports (list[Report]): The list of reports to include in the result.
+
+        Returns:
+            The created SanityResult.
+        """
         return cls(
             dataset_id=context.dataset_id.value_or("UNKNOWN"),
             version=context.version.value_or(None),

t4_devkit/sanity/run.py

@@ -17,6 +17,17 @@ def sanity_check(
     include_warning: bool = False,
     excludes: Sequence[str] | None = None,
 ) -> SanityResult:
+    """Run sanity checks on the given data root.
+
+    Args:
+        data_root (str): The root directory of the data.
+        revision (str | None, optional): The revision to check. If None, the latest revision is used.
+        include_warning (bool, optional): Whether to include warning checks.
+        excludes (Sequence[str] | None, optional): A list of rule names or groups to exclude.
+
+    Returns:
+        A SanityResult object.
+    """
     with warnings.catch_warnings():
         if include_warning:
             warnings.simplefilter("error")