Skip to content

DOC: Inconsistent use of code-style formatting (backticks) in docstrings #53674

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/reference/api/pandas.read_csv.html

Documentation problem

Multiple docstrings lack code-style formatting (backticks) where it should be used. For example, in the read_csv and read_excel docstrings, there are cases where list literals are written in plain text instead of enclosed in backticks, and multiple parameter or object names are either not formatted or formatted using italics rather than backticks as prescribed in the documentation guide.

Suggested fix for documentation

I am suggesting edits to all docstrings to update this formatting for consistency. I suggest this be done incrementally starting with the most-used functions (readers, for example). I am willing to work on this and can do it in chunks (i.e. one pull request per file or even per function depending on what would be recommended).

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions