Skip to content

DOC: Incorrect mention of dtype_backend_option in convert_dtypes docstring #52390

Closed
@paultiq

Description

@paultiq

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.convert_dtypes.html

Documentation problem

Documentation references features that didn't ship in 2.0.0 (they were in RC1): pd.set_option("mode.dtype_backend", "pyarrow")

New in version 2.0: The nullable dtype implementation can be configured by calling pd.set_option("mode.dtype_backend", "pandas") to use numpy-backed nullable dtypes or pd.set_option("mode.dtype_backend", "pyarrow") to use pyarrow-backed nullable dtypes (using pd.ArrowDtype).

Suggested fix for documentation

Remove or update reference to be consistent with https://pandas.pydata.org/docs/dev/whatsnew/v2.0.0.html.

Instead of the mode.dtype_backend, reference this from the release notes:

The following functions gained a new keyword dtype_backend (GH36712)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions