Skip to content

DOC: Make ExtensionArray not experimental #47225

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 2 commits into from
Jun 10, 2022
Merged

Conversation

Dr-Irv
Copy link
Contributor

@Dr-Irv Dr-Irv commented Jun 4, 2022

Updates docs to make ExtensionArray and ExtensionDtype not experimental

@Dr-Irv Dr-Irv added Docs ExtensionArray Extending pandas with custom dtypes or arrays. labels Jun 4, 2022
@jreback jreback added this to the 1.5 milestone Jun 5, 2022
The :class:`pandas.api.extensions.ExtensionDtype` and :class:`pandas.api.extensions.ExtensionArray` APIs are new and
experimental. They may change between versions without warning.
The :class:`pandas.api.extensions.ExtensionDtype` and :class:`pandas.api.extensions.ExtensionArray` APIs were
experimental prior to pandas 1.4. Starting with version 1.4, future changes will follow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we say prior to 1.5 (nbd deal really)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Fixed in next commit.

experimental. They may change between versions without warning.
The :class:`pandas.api.extensions.ExtensionDtype` and :class:`pandas.api.extensions.ExtensionArray` APIs were
experimental prior to pandas 1.5. Starting with version 1.5, future changes will follow
the :ref:`pandas deprecation policy <policies.version>`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In practice we were already following that policy for earlier versions as well, but not sure if that nuance is important for the user (we could also say retro-actively that they were stable since 1.0, because I don't think we had breaking changes since then)

@jreback jreback merged commit 57f5c51 into pandas-dev:main Jun 10, 2022
@jreback
Copy link
Contributor

jreback commented Jun 10, 2022

thanks @Dr-Irv

yehoshuadimarsky pushed a commit to yehoshuadimarsky/pandas that referenced this pull request Jul 13, 2022
@Dr-Irv Dr-Irv deleted the extensiondoc branch February 13, 2023 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs ExtensionArray Extending pandas with custom dtypes or arrays.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API: How much of the EA API can we commit to?
4 participants