pointblank 0.8.7__py3-none-any.whl → 0.9.0__py3-none-any.whl

pointblank/datascan.py

@@ -857,9 +857,9 @@ def col_summary_tbl(data: FrameT | Any, tbl_name: str | None = None) -> GT:
     ```{python}
     import pointblank as pb
 
-    small_table_polars = pb.load_dataset(dataset="small_table", tbl_type="polars")
+    small_table = pb.load_dataset(dataset="small_table", tbl_type="polars")
 
-    pb.col_summary_tbl(data=small_table_polars)
+    pb.col_summary_tbl(data=small_table)
     ```
 
     This table used above was a Polars DataFrame, but the `col_summary_tbl()` function works with
@@ -867,9 +867,9 @@ def col_summary_tbl(data: FrameT | Any, tbl_name: str | None = None) -> GT:
     Here's an example using a DuckDB table handled by Ibis:
 
     ```{python}
-    small_table_duckdb = pb.load_dataset(dataset="nycflights", tbl_type="duckdb")
+    nycflights = pb.load_dataset(dataset="nycflights", tbl_type="duckdb")
 
-    pb.col_summary_tbl(data=small_table_duckdb, tbl_name="nycflights")
+    pb.col_summary_tbl(data=nycflights, tbl_name="nycflights")
     ```
     """
 

pointblank/draft.py

@@ -119,7 +119,7 @@ class DraftValidation:
     data = pb.load_dataset(dataset="nycflights", tbl_type="duckdb")
 
     # Draft a validation plan for the "nycflights" table
-    pb.DraftValidation(data=nycflights, model="anthropic:claude-3-5-sonnet-latest")
+    pb.DraftValidation(data=data, model="anthropic:claude-3-5-sonnet-latest")
     ```
 
     The output will be a drafted validation plan for the `"nycflights"` table and this will appear

pointblank/thresholds.py

@@ -452,6 +452,11 @@ class Actions:
     all three thresholds are exceeded in step 3, the 'warning' action of executing the function
     occurs (resulting in a message being printed to the console). If actions were set for the other
     two threshold levels, they would also be executed.
+
+    See Also
+    --------
+    The [`get_action_metadata()`](`pointblank.get_action_metadata`) function, which can be used to
+    retrieve metadata about the step where the action is executed.
     """
 
     warning: str | Callable | list[str | Callable] | None = None
@@ -589,6 +594,11 @@ class FinalActions:
         .interrogate()
     )
     ```
+
+    See Also
+    --------
+    The [`get_validation_summary()`](`pointblank.get_validation_summary`) function, which can be
+    used to retrieve the summary of the validation results.
     """
 
     actions: list | str | Callable