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: read_csv docstring incorrectly references itself in the "See Also" section #53847

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

DOC: read_csv docstring incorrectly references itself in the "See Also" section #53847

tpaxman opened this issue Jun 25, 2023 · 1 comment · Fixed by #53848
Labels

Comments

@tpaxman
Copy link
Contributor

tpaxman commented Jun 25, 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/api/pandas.read_csv.html

Documentation problem

In the read_csv docstring, under "See Also" it lists itself instead of some other relevant function such as read_table. This is apparently because read_csv and read_table share a docstring template but this value was not parameterized like other details such as the function summary string and the default sep value.

Suggested fix for documentation

I suggest replacing read_csv with read_table in the "See Also" section. This could be done by adding another string formatting parameter when the @Appender decorator is called for both the read_csv and read_table functions, such that they include the other under "See Also".

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

take

@dewonlupin dewonlupin removed their assignment Jun 25, 2023
@tpaxman tpaxman changed the title DOC: read_csv incorrectly includes a reference to itself in the "See Also" docstring section DOC: read_csv docstring incorrectly includes a reference to itself in the "See Also" section Jun 26, 2023
@tpaxman tpaxman changed the title DOC: read_csv docstring incorrectly includes a reference to itself in the "See Also" section DOC: read_csv docstring incorrectly references itself in the "See Also" section Jun 26, 2023
@lithomas1 lithomas1 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants