Skip to content

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

@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/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".

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