-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: escaping code examples properly in read_csv docstring #18412
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #18412 +/- ##
==========================================
- Coverage 91.36% 91.34% -0.02%
==========================================
Files 164 164
Lines 49733 49733
==========================================
- Hits 45439 45430 -9
- Misses 4294 4303 +9
Continue to review full report at Codecov.
|
pandas/io/parsers.py
Outdated
fully commented lines are ignored by the parameter `header` but not by | ||
`skiprows`. For example, if comment='#', parsing '#empty\\na,b,c\\n1,2,3' | ||
with `header=0` will result in 'a,b,c' being | ||
fully commented lines are ignored by the parameter ``header`` but not by |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you leave 'header' (and skiprows below) with single backticks? (that's how literal references to kwargs are done in the rest of the docstring I think).
For the code example, the double ones are good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup, done
Thanks! |
Can you check http://pandas-docs.github.io/pandas-docs-travis/generated/pandas.read_csv.html#pandas.read_csv in a few hours to see if it now is correctly displaying? |
Will do, just set a reminder. I checked it locally, but will take a look at the resulting production documentation later today. Edit: It looks just fine. |
- [ ] tests added / passed- [ ] passesgit diff upstream/master -u -- "*.py" | flake8 --diff
- [ ] whatsnew entry