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: Make code formatting corrections in read_csv description #54107

Closed
tpaxman opened this issue Jul 13, 2023 · 1 comment · Fixed by #54136
Closed

DOC: Make code formatting corrections in read_csv description #54107

tpaxman opened this issue Jul 13, 2023 · 1 comment · Fixed by #54136
Assignees
Labels

Comments

@tpaxman
Copy link
Contributor

tpaxman commented Jul 13, 2023

The following suggestions were made @Charlie-XIAO after #53735 was closed and I think they could be added:

Sorry for chipping in @tpaxman. Though "pandas" is a module, IMHO it should not be enclosed in backticks here? I don't see it being considered inline code anywhere else in the docs either. (Just mentioning this because I see you making some doc contributions recently. Maybe you can make this change in one of your currently open PRs if you agree with my point).

Some other suggestions

  1. I think lists should have spaces after the commas in [0,1,3].
  1. Not sure but do you think these should be considered string literals? Currently its a bit hard to tell them apart because the quotation marks in text mode is small (especially that the empty string '' is hard to tell at first glance).

Originally posted by @Charlie-XIAO in #53735 (comment)

@lithomas1 lithomas1 added the Docs label Jul 14, 2023
@Tianye-Song
Copy link
Contributor

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants