add examples to select docstrings

pola-rs · Jan 29, 2023 · 7fe63f5 · 7fe63f5
1 parent ac61ce6
commit 7fe63f5
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/py-polars/polars/internals/dataframe/frame.py b/py-polars/polars/internals/dataframe/frame.py
@@ -5589,6 +5589,22 @@ def select(
         │ 10      │
         └─────────┘
 
+        Note that, when using kwargs syntax, expressions with multiple
+        outputs are automatically instantiated as Struct columns:
+
+        >>> from polars.datatypes import INTEGER_DTYPES
+        >>> df.select(odd=(pl.col(INTEGER_DTYPES) % 2).suffix("_is_odd"))
+        shape: (3, 1)
+        ┌───────────┐
+        │ odd       │
+        │ ---       │
+        │ struct[2] │
+        ╞═══════════╡
+        │ {1,0}     │
+        │ {0,1}     │
+        │ {1,0}     │
+        └───────────┘
+
         """
         return self._from_pydf(
             self.lazy().select(exprs, **named_exprs).collect(no_optimization=True)._df
@@ -5694,7 +5710,7 @@ def with_columns(
         │ 4   ┆ 13.0 ┆ true  ┆ 52.0 ┆ false │
         └─────┴──────┴───────┴──────┴───────┘
 
-        Note that, when using kwarg syntax, expressions with multiple
+        Note that, when using kwargs syntax, expressions with multiple
         outputs are automatically instantiated as Struct columns:
 
         >>> df.drop("c").with_columns(

diff --git a/py-polars/polars/internals/lazyframe/frame.py b/py-polars/polars/internals/lazyframe/frame.py
@@ -1641,6 +1641,22 @@ def select(
         │ 10      │
         └─────────┘
 
+        Note that, when using kwargs syntax, expressions with multiple
+        outputs are automatically instantiated as Struct columns:
+
+        >>> from polars.datatypes import INTEGER_DTYPES
+        >>> df.select(odd=(pl.col(INTEGER_DTYPES) % 2).suffix("_is_odd")).collect()
+        shape: (3, 1)
+        ┌───────────┐
+        │ odd       │
+        │ ---       │
+        │ struct[2] │
+        ╞═══════════╡
+        │ {1,0}     │
+        │ {0,1}     │
+        │ {1,0}     │
+        └───────────┘
+
         """
         if exprs is None and not named_exprs:
             raise ValueError("Expected at least one of 'exprs' or **named_exprs")
@@ -2537,7 +2553,7 @@ def with_columns(
         │ 4   ┆ 13.0 ┆ true  ┆ 52.0 ┆ false │
         └─────┴──────┴───────┴──────┴───────┘
 
-        Note that, when using kwarg syntax, expressions with multiple
+        Note that, when using kwargs syntax, expressions with multiple
         outputs are automatically instantiated as Struct columns:
 
         >>> ldf.drop("c").with_columns(