docstrings

great-expectations · May 18, 2023 · cf5d1bb · cf5d1bb
1 parent e5d0da1
commit cf5d1bb
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/great_expectations/validator/metrics_calculator.py b/great_expectations/validator/metrics_calculator.py
@@ -46,6 +46,12 @@ def show_progress_bars(self, enable: bool) -> None:
     def columns(self, domain_kwargs: Optional[Dict[str, Any]] = None) -> List[str]:
         """
         Convenience method to run "table.columns" metric.
+
+        Arguments:
+            domain_kwargs: Optional dictionary of domain kwargs (e.g., containing "batch_id").
+
+        Returns:
+            The list of Batch columns.
         """
         if domain_kwargs is None:
             domain_kwargs = {}
@@ -71,8 +77,17 @@ def head(
         domain_kwargs: Optional[Dict[str, Any]] = None,
         fetch_all: bool = False,
     ) -> pd.DataFrame:
-        """
-        Convenience method to run "table.head" metric.
+        """Convenience method to return the first several rows or records from a Batch of data.
+
+        (To be deprecated in favor of using methods in "MetricsCalculator" class.)
+
+        Args:
+            n_rows: The number of rows to return.
+            domain_kwargs: If provided, the domain for which to return records.
+            fetch_all: If True, ignore n_rows and return the entire batch.
+
+        Returns:
+            A Pandas DataFrame containing the records' data.
         """
         if domain_kwargs is None:
             domain_kwargs = {}

diff --git a/great_expectations/validator/validator.py b/great_expectations/validator/validator.py
@@ -383,10 +383,15 @@ def compute_metrics(
 
     @public_api
     def columns(self, domain_kwargs: Optional[Dict[str, Any]] = None) -> List[str]:
-        """
-        Convenience method to obtain Batch columns.
+        """Convenience method to obtain Batch columns.
 
         (To be deprecated in favor of using methods in "MetricsCalculator" class.)
+
+        Arguments:
+            domain_kwargs: Optional dictionary of domain kwargs (e.g., containing "batch_id").
+
+        Returns:
+            The list of Batch columns.
         """
         return self._metrics_calculator.columns(domain_kwargs=domain_kwargs)
 
@@ -397,7 +402,9 @@ def head(
         domain_kwargs: Optional[Dict[str, Any]] = None,
         fetch_all: bool = False,
     ) -> pd.DataFrame:
-        """Return the first several rows or records from a Batch of data.
+        """Convenience method to return the first several rows or records from a Batch of data.
+
+        (To be deprecated in favor of using methods in "MetricsCalculator" class.)
 
         Args:
             n_rows: The number of rows to return.