Skip to content

DOC: ES01 fix for to_csv method #57597

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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DataFrame.sparse.from_spmatrix\
pandas.DataFrame.sparse.to_coo\
pandas.DataFrame.sparse.to_dense\
pandas.DataFrame.to_csv\
pandas.DataFrame.to_feather\
pandas.DataFrame.to_html\
pandas.DataFrame.to_markdown\
Expand Down
13 changes: 12 additions & 1 deletion pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -3670,7 +3670,18 @@ def to_csv(
storage_options: StorageOptions | None = None,
) -> str | None:
r"""
Write object to a comma-separated values (csv) file.
Write object to a comma-separated values (CSV) file.

This method enables users to write object to comma-separated values (CSV) file
with customizable options. These options include specifying the delimiter,
handling missing data, formatting numbers, selecting columns, including
headers and row names, defining file opening modes, setting encoding and
compression options, controlling quoting and escaping characters, specifying
newline characters, managing chunk sizes, formatting datetime objects, handling
errors during encoding/decoding, and providing storage connection options.

The method returns None if ``path_or_buf`` is not specified;
otherwise, it returns the resulting CSV format as a string.

Parameters
----------
Expand Down