Skip to content

DOC: Add experimental note to DatetimeArray and TimedeltaArray #24882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 24, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wording
  • Loading branch information
TomAugspurger committed Jan 23, 2019
commit e068fee345eba58589a6e4617c58e3fd7a5560d3
9 changes: 5 additions & 4 deletions pandas/core/arrays/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,9 @@ class DatetimeArray(dtl.DatetimeLikeArrayMixin,
.. warning::

DatetimeArray is currently experimental, and its API may change
without warning. In particular, :meth:`DatetimeArray.dtype` is
expected to change to always be an ``ExtensionDtype``.
without warning. In particular, :attr:`DatetimeArray.dtype` is
expected to change to always be an instance of an ``ExtensionDtype``
subclass.

Parameters
----------
Expand Down Expand Up @@ -520,8 +521,8 @@ def dtype(self):
.. warning::

A future version of pandas will change dtype to never be a
``numpy.dtype``. Instead it will always be a subclass of
:class:`pandas.api.extensions.ExtensionDtype`.
``numpy.dtype``. Instead, :attr:`DatetimeArray.dtype` will
always be an instance of an ``ExtensionDtype`` subclass.

Returns
-------
Expand Down
5 changes: 3 additions & 2 deletions pandas/core/arrays/timedeltas.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ class TimedeltaArray(dtl.DatetimeLikeArrayMixin, dtl.TimelikeOps):
.. warning::

TimedeltaArray is currently experimental, and its API may change
without warning. In particular, :meth:`TimedeltaArray.dtype` is
expected to change to be an ``ExtensionDtype``.
without warning. In particular, :attr:`TimedeltaArray.dtype` is
expected to change to be an instance of an ``ExtensionDtype``
subclass.

Parameters
----------
Expand Down