Skip to content

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

Merged
merged 2 commits into from
Nov 22, 2017
Merged

Conversation

kokes
Copy link
Contributor

@kokes kokes commented Nov 21, 2017

@codecov
Copy link

codecov bot commented Nov 21, 2017

Codecov Report

Merging #18412 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 89.14% <ø> (ø) ⬆️
#single 39.62% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/io/parsers.py 95.59% <ø> (ø) ⬆️
pandas/io/gbq.py 25% <0%> (-58.34%) ⬇️
pandas/core/frame.py 97.8% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c4a2cd3...9531e1c. Read the comment docs.

@jreback jreback added the Docs label Nov 22, 2017
@jreback
Copy link
Contributor

jreback commented Nov 22, 2017

@jorisvandenbossche jorisvandenbossche changed the title escaping code examples properly DOC: escaping code examples properly in read_csv docstring Nov 22, 2017
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
Copy link
Member

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, done

@jorisvandenbossche jorisvandenbossche merged commit c619a67 into pandas-dev:master Nov 22, 2017
@jorisvandenbossche
Copy link
Member

Thanks!

@jorisvandenbossche
Copy link
Member

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?

@kokes
Copy link
Contributor Author

kokes commented Nov 22, 2017

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.

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 this pull request may close these issues.

Newline backslash stripped
3 participants