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

[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).

[rhshadrach]

+1

[tpaxman]

take

[tpaxman]

@rhshadrach : I have prepared a pull request where I have addressed this issue in the read_csv documentation only. Since this issue would only be partially completed by that PR, should I instead be creating a read_csv-specific copy of this issue and link that to my pull request? Or can I just reference this general issue in the PR and note that my PR only completes a portion of it? Curious about what is standard procedure. Thank you.

[rhshadrach]

Either way would be fine, but

Or can I just reference this general issue in the PR and note that my PR only completes a portion of it?

is typically what's done. We do not require a PR closes an issue.

[GarrettDaniel]

I'd be happy to help with the read_excel docstring if it's still needed!