docs(python): add doc for future: int

pola-rs · Jul 4, 2024 · 22fc7f2 · 22fc7f2
1 parent fe24b38
commit 22fc7f2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/py-polars/polars/dataframe/frame.py b/py-polars/polars/dataframe/frame.py
@@ -1404,6 +1404,9 @@ def to_arrow(self, *, future: bool | int = False) -> pa.Table:
                 This functionality is considered **unstable**. It may be changed
                 at any point without it being considered a breaking change.
 
+            Setting this to an integer will use a specific version
+            of Polars' internal data structures.
+
         Examples
         --------
         >>> df = pl.DataFrame(
@@ -3339,6 +3342,9 @@ def write_ipc(
                 This functionality is considered **unstable**. It may be changed
                 at any point without it being considered a breaking change.
 
+            Setting this to an integer will use a specific version
+            of Polars' internal data structures.
+
         Examples
         --------
         >>> import pathlib
@@ -3417,6 +3423,9 @@ def write_ipc_stream(
                 This functionality is considered **unstable**. It may be changed
                 at any point without it being considered a breaking change.
 
+            Setting this to an integer will use a specific version
+            of Polars' internal data structures.
+
         Examples
         --------
         >>> import pathlib

diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py
@@ -4358,6 +4358,9 @@ def to_arrow(self, *, future: bool | int = False) -> pa.Array:
                 This functionality is considered **unstable**. It may be changed
                 at any point without it being considered a breaking change.
 
+            Setting this to an integer will use a specific version
+            of Polars' internal data structures.
+
         Examples
         --------
         >>> s = pl.Series("a", [1, 2, 3])