docs(python): Mark hypothesis testing functionality as unstable (#17258)

pola-rs · Jun 28, 2024 · 7f99de8 · 7f99de8
1 parent 855b3fc
commit 7f99de8
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 0 deletions.
diff --git a/py-polars/polars/testing/parametric/profiles.py b/py-polars/polars/testing/parametric/profiles.py
@@ -14,6 +14,10 @@ def load_profile(
     """
     Load a named (or custom) hypothesis profile for use with the parametric tests.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     profile : {str, int}, optional
@@ -71,6 +75,10 @@ def set_profile(profile: ParametricProfileNames | int) -> None:
     """
     Set the env var `POLARS_HYPOTHESIS_PROFILE` to the given profile name/value.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     profile : {str, int}, optional

diff --git a/py-polars/polars/testing/parametric/strategies/core.py b/py-polars/polars/testing/parametric/strategies/core.py
@@ -49,6 +49,10 @@ def series(  # noqa: D417
     """
     Hypothesis strategy for producing Polars Series.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     name : {str, strategy}, optional
@@ -284,6 +288,10 @@ def dataframes(  # noqa: D417
     """
     Hypothesis strategy for producing Polars DataFrames or LazyFrames.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     cols : {int, columns}, optional
@@ -493,6 +501,10 @@ class column:
     """
     Define a column for use with the `dataframes` strategy.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     name : str

diff --git a/py-polars/polars/testing/parametric/strategies/data.py b/py-polars/polars/testing/parametric/strategies/data.py
@@ -256,6 +256,10 @@ def lists(
     """
     Create a strategy for generating lists of the given data type.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     inner_dtype

diff --git a/py-polars/polars/testing/parametric/strategies/dtype.py b/py-polars/polars/testing/parametric/strategies/dtype.py
@@ -95,6 +95,10 @@ def dtypes(
     """
     Create a strategy for generating Polars :class:`DataType` objects.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Parameters
     ----------
     allowed_dtypes

diff --git a/py-polars/polars/testing/parametric/strategies/legacy.py b/py-polars/polars/testing/parametric/strategies/legacy.py
@@ -34,6 +34,10 @@ def columns(
     .. deprecated:: 0.20.26
         Use :class:`column` instead in conjunction with a list comprehension.
 
+    .. warning::
+        This functionality is currently considered **unstable**. It may be
+        changed at any point without it being considered a breaking change.
+
     Generate a fixed sequence of `column` objects suitable for passing to the
     @dataframes strategy, or using standalone (note that this function is not itself
     a strategy).