Skip to content
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

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

Closed
1 task done
tpaxman opened this issue Jun 27, 2023 · 1 comment · Fixed by #54104
Closed
1 task done

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

tpaxman opened this issue Jun 27, 2023 · 1 comment · Fixed by #54104
Assignees
Labels

Comments

@tpaxman
Copy link
Contributor

tpaxman commented Jun 27, 2023

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.

@tpaxman tpaxman added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 27, 2023
@tpaxman
Copy link
Contributor Author

tpaxman commented Jun 27, 2023

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment