Add docstring for mask= in LocBody

posit-dev · Dec 17, 2024 · 993baff · 993baff
1 parent e2d150d
commit 993baff
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/great_tables/_locations.py b/great_tables/_locations.py
@@ -502,6 +502,14 @@ class LocBody(Loc):
     rows
         The rows to target. Can either be a single row name or a series of row names provided in a
         list.
+    mask
+        The cells to target. If the underlying wrapped DataFrame is a Polars DataFrame,
+        you can pass a Polars expression for cell-based selection. This argument must be used
+        exclusively and cannot be combined with the `columns=` or `rows=` arguments.
+
+    :::{.callout-warning}
+    `mask=` is still experimental.
+    :::
 
     Returns
     -------