Skip to content

CI: Fail doc build on warning #22743

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
wants to merge 32 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1168273
FutureWarning from groupby.
TomAugspurger Sep 18, 2018
41c8297
Purge read_table
TomAugspurger Sep 18, 2018
2e76e84
Removed nested list example
TomAugspurger Sep 18, 2018
a70f86d
Fixed resample __iter__
TomAugspurger Sep 18, 2018
e4a8b06
Old whatsnew
TomAugspurger Sep 18, 2018
693eead
Ecosystem
TomAugspurger Sep 18, 2018
e6b2c09
to_csv
TomAugspurger Sep 18, 2018
a7f0b38
to_json
TomAugspurger Sep 18, 2018
ff3d2dd
Handle subpackages better
TomAugspurger Sep 18, 2018
e544249
Fixed unexpected indent
TomAugspurger Sep 18, 2018
8bdb920
Fixed "inline interpreted text..."
TomAugspurger Sep 18, 2018
ae0f8ff
Fixed "malformed hyperlink target"
TomAugspurger Sep 18, 2018
a275dfb
Add warnings to CLI
TomAugspurger Sep 18, 2018
b190866
Fixed unexpected indentation
TomAugspurger Sep 18, 2018
a46e4c7
newline after directive
TomAugspurger Sep 18, 2018
74af53d
Maybe fix na_value not included in toctree
TomAugspurger Sep 18, 2018
1668c65
Fixed no link to na_value
TomAugspurger Sep 18, 2018
dda2bfc
Fixed II ref
TomAugspurger Sep 18, 2018
a2b31ab
Fixed options ref
TomAugspurger Sep 18, 2018
9f0a948
Fixed link to Resmpaler
TomAugspurger Sep 18, 2018
158c46d
Change warning, error, linting
TomAugspurger Sep 18, 2018
c1a5ab8
Sample warning
TomAugspurger Sep 19, 2018
bbcd7bd
update contributing
TomAugspurger Sep 19, 2018
c8f206c
lint
TomAugspurger Sep 19, 2018
c917101
Merge remote-tracking branch 'upstream/master' into doc-warnings
TomAugspurger Sep 20, 2018
30c9174
Fix call
TomAugspurger Sep 20, 2018
5e0b275
write a parser
TomAugspurger Sep 20, 2018
384ace8
try to exit
TomAugspurger Sep 20, 2018
6a2a060
lint
TomAugspurger Sep 20, 2018
378bd6d
Rework doc build
TomAugspurger Sep 20, 2018
8859f97
executable scripts
TomAugspurger Sep 20, 2018
b9331f1
activate
TomAugspurger Sep 20, 2018
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
Prev Previous commit
Next Next commit
to_csv
  • Loading branch information
TomAugspurger committed Sep 18, 2018
commit e6b2c09284f2d68e38c1d5df06a966817a802d63
27 changes: 19 additions & 8 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -9513,8 +9513,11 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
path_or_buf : string or file handle, default None
File path or object, if None is provided the result is returned as
a string.

.. versionchanged:: 0.24.0
Was previously named "path" for Series.

Was previously named "path" for Series.

sep : character, default ','
Field delimiter for the output file.
na_rep : string, default ''
Expand All @@ -9526,8 +9529,11 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
header : boolean or list of string, default True
Write out the column names. If a list of strings is given it is
assumed to be aliases for the column names

.. versionchanged:: 0.24.0
Previously defaulted to False for Series.

Previously defaulted to False for Series.

index : boolean, default True
Write row names (index)
index_label : string or sequence, or False, default None
Expand All @@ -9541,14 +9547,16 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
encoding : string, optional
A string representing the encoding to use in the output file,
defaults to 'ascii' on Python 2 and 'utf-8' on Python 3.
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I couldn't get this line-wrapping to work properly by ending the line with a backslash. Does anyone know the correct syntax? I'm inclided to just get the docs right and # noqa at the end of the line.

default 'infer'
If 'infer' and `path_or_buf` is path-like, then detect compression
from the following extensions: '.gz', '.bz2', '.zip' or '.xz'
(otherwise no compression).
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}

If 'infer' (the defualt) and `path_or_buf` is path-like, then
detect compression from the following extensions: '.gz', '.bz2',
'.zip' or '.xz' (otherwise no compression).

.. versionchanged:: 0.24.0

'infer' option added and set to default

line_terminator : string, default ``'\n'``
The newline character or character sequence to use in the output
file
Expand All @@ -9565,7 +9573,9 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
chunksize : int or None
rows to write at a time
tupleize_cols : boolean, default False

.. deprecated:: 0.21.0

This argument will be removed and will always write each row
of the multi-index as a separate row in the CSV file.

Expand All @@ -9579,7 +9589,8 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
European data

.. versionchanged:: 0.24.0
The order of arguments for Series was changed.

The order of arguments for Series was changed.
"""

df = self if isinstance(self, ABCDataFrame) else self.to_frame()
Expand Down