docs(python): Add a not about index access on struct.field (pola-rs#1…

…6389)
Wouittone · Jun 22, 2024 · 1df9a6c · 1df9a6c
1 parent ef74013
commit 1df9a6c
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/py-polars/polars/expr/struct.py b/py-polars/polars/expr/struct.py
@@ -126,6 +126,22 @@ def field(self, name: str | list[str], *more_names: str) -> Expr:
         │ 2   ┆ cd  │
         └─────┴─────┘
 
+        Notes
+        -----
+        The `struct` namespace has implemented `__getitem__`
+        so you can also access fields by index:
+
+        >>> df.select(pl.col("struct_col").struct[1])
+        shape: (2, 1)
+        ┌─────┐
+        │ bbb │
+        │ --- │
+        │ str │
+        ╞═════╡
+        │ ab  │
+        │ cd  │
+        └─────┘
+
         """
         if more_names:
             name = [*([name] if isinstance(name, str) else name), *more_names]