Skip to content

Commit

Permalink
Backport PR pandas-dev#25624: DOC: file obj for to_csv must be newlin…
Browse files Browse the repository at this point in the history
…e=''
  • Loading branch information
chris-b1 authored and MeeseeksDev[bot] committed Mar 11, 2019
1 parent f70f2b6 commit f9eef39
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/source/user_guide/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1689,7 +1689,7 @@ The ``Series`` and ``DataFrame`` objects have an instance method ``to_csv`` whic
allows storing the contents of the object as a comma-separated-values file. The
function takes a number of arguments. Only the first is required.

* ``path_or_buf``: A string path to the file to write or a StringIO
* ``path_or_buf``: A string path to the file to write or a file object. If a file object it must be opened with `newline=''`
* ``sep`` : Field delimiter for the output file (default ",")
* ``na_rep``: A string representation of a missing value (default '')
* ``float_format``: Format string for floating point numbers
Expand All @@ -1702,7 +1702,7 @@ function takes a number of arguments. Only the first is required.
* ``mode`` : Python write mode, default 'w'
* ``encoding``: a string representing the encoding to use if the contents are
non-ASCII, for Python versions prior to 3
* ``line_terminator``: Character sequence denoting line end (default '\\n')
* ``line_terminator``: Character sequence denoting line end (default `os.linesep`)
* ``quoting``: Set quoting rules as in csv module (default csv.QUOTE_MINIMAL). Note that if you have set a `float_format` then floats are converted to strings and csv.QUOTE_NONNUMERIC will treat them as non-numeric
* ``quotechar``: Character used to quote fields (default '"')
* ``doublequote``: Control quoting of ``quotechar`` in fields (default True)
Expand Down
3 changes: 2 additions & 1 deletion pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2895,7 +2895,8 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
----------
path_or_buf : str or file handle, default None
File path or object, if None is provided the result is returned as
a string.
a string. If a file object is passed it should be opened with
`newline=''`, disabling universal newlines.
.. versionchanged:: 0.24.0
Expand Down

0 comments on commit f9eef39

Please sign in to comment.