Add experimental note

pandas-dev · Aug 10, 2022 · 4e3b3b9 · 4e3b3b9
1 parent 02e3aa4
commit 4e3b3b9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/doc/source/whatsnew/v1.5.0.rst b/doc/source/whatsnew/v1.5.0.rst
@@ -54,6 +54,8 @@ initialized with a ``pyarrow.DataType``.
 Most operations are supported and have been implemented using `pyarrow compute <https://arrow.apache.org/docs/python/api/compute.html>`__ functions.
 We recommend installing the latest version of PyArrow to access the most recently implemented compute functions.
 
+This feature is experimental and may change in a future release.
+
 .. _whatsnew_150.enhancements.dataframe_interchange:
 
 DataFrame interchange protocol implementation

diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py
@@ -161,6 +161,11 @@ class ArrowExtensionArray(OpsMixin, ExtensionArray):
     """
     Pandas ExtensionArray backed by a PyArrow ChunkedArray.
 
+    .. warning::
+
+       ArrowExtensionArray is considered experimental. The implementation and
+       parts of the API may change without warning.
+
     Parameters
     ----------
     values : pyarrow.Array or pyarrow.ChunkedArray

diff --git a/pandas/core/arrays/arrow/dtype.py b/pandas/core/arrays/arrow/dtype.py
@@ -19,6 +19,11 @@ class ArrowDtype(StorageExtensionDtype):
     """
     An ExtensionDtype for PyArrow data types.
 
+    .. warning::
+
+       ArrowDtype is considered experimental. The implementation and
+       parts of the API may change without warning.
+
     While most ``dtype`` arguments can accept the "string"
     constructor, e.g. ``int64[pyarrow]``, ArrowDtype is useful
     if the data type contains parameters like ``pyarrow.timestamp``.