Skip to content

DOC: The dtype_backend parameter description is repeated manually in 16 functions #53878

Closed
@tpaxman

Description

@tpaxman

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/dev/reference/io.html

Documentation problem

The dtype_backend parameter was implemented in 16 different functions in version 2.0.0. The docstring description for the parameter was repeated in each function docstring. These functions are contained in the following files:

pandas/core/tools/numeric.py
pandas/core/generic.py
pandas/io/clipboards.py
pandas/io/sql.py
pandas/io/xml.py
pandas/io/parquet.py
pandas/io/feather_format.py
pandas/io/html.py
pandas/io/spss.py
pandas/io/excel/_base.py
pandas/io/orc.py
pandas/io/parsers/readers.py
pandas/io/json/_json.py

Suggested fix for documentation

Extract the description into pandas/core/shared_docs.py and pass it as a format string parameter to each docstring, similar to what was done with decompression_options and others, for example.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions