Skip to content

Too many backslashes stripped in documentation generation #13738

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

Closed
kokes opened this issue Jul 21, 2016 · 2 comments · Fixed by #13761
Closed

Too many backslashes stripped in documentation generation #13738

kokes opened this issue Jul 21, 2016 · 2 comments · Fixed by #13761
Labels
Milestone

Comments

@kokes
Copy link
Contributor

kokes commented Jul 21, 2016

I've noticed the generated documentation for to_csv strips backslashes in the newline character

line_terminator : string, default ‘n’

I thought it was a case of slash stripping, but I checked the code and it's double backslashed there - so the doc generation is a bit aggressive. The IO doc is fine, its code is the same - double backslashed.

@jorisvandenbossche
Copy link
Member

Thanks for reporting. The read_csv docs seem to have the same problem (http://pandas-docs.github.io/pandas-docs-travis/generated/pandas.read_csv.html) for the sep and delim_whitespace keywords.

Probably easiest solved by making it raw strings of some of them (r"..."). Interested in trying to fix this?

@shawnheide
Copy link
Contributor

I looked into this and made the changes to fix it. Just for reference, it also impacted read_table, as it was tied into the docs with read_csv.

shawnheide added a commit to shawnheide/pandas that referenced this issue Jul 25, 2016
…, and to_csv in ordert to produce correct docs and docstrings
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