docs(arbitrary): add example for arbitrary method docstring (#9596)

ibis-project · Jul 15, 2024 · 09cfd85 · 09cfd85
1 parent 9b797f6
commit 09cfd85
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/ibis/expr/types/generic.py b/ibis/expr/types/generic.py
@@ -1996,6 +1996,31 @@ def arbitrary(
         -------
         Scalar
             An expression
+
+        Examples
+        --------
+        >>> import ibis
+        >>> ibis.options.interactive = True
+        >>> t = ibis.memtable({"a": [1, 2, 2], "b": list("aaa"), "c": [4.0, 4.1, 4.2]})
+        >>> t
+        ┏━━━━━━━┳━━━━━━━━┳━━━━━━━━━┓
+        ┃ a     ┃ b      ┃ c       ┃
+        ┡━━━━━━━╇━━━━━━━━╇━━━━━━━━━┩
+        │ int64 │ string │ float64 │
+        ├───────┼────────┼─────────┤
+        │     1 │ a      │     4.0 │
+        │     2 │ a      │     4.1 │
+        │     2 │ a      │     4.2 │
+        └───────┴────────┴─────────┘
+        >>> t.group_by("a").agg(arb=t.b.arbitrary(), c=t.c.sum())
+        ┏━━━━━━━┳━━━━━━━━┳━━━━━━━━━┓
+        ┃ a     ┃ arb    ┃ c       ┃
+        ┡━━━━━━━╇━━━━━━━━╇━━━━━━━━━┩
+        │ int64 │ string │ float64 │
+        ├───────┼────────┼─────────┤
+        │     2 │ a      │     8.3 │
+        │     1 │ a      │     4.0 │
+        └───────┴────────┴─────────┘
         """
         if how is not None:
             warn_deprecated(