Skip to content

Commit fc0367a

Browse files
committed
DOC: fix compression docs in io.rst
1 parent 7ee6d08 commit fc0367a

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

doc/source/io.rst

+9-4
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,15 @@ chunksize : int, default ``None``
217217
Quoting, Compression, and File Format
218218
+++++++++++++++++++++++++++++++++++++
219219

220-
compression : {``'infer'``, ``'gzip'``, ``'bz2'``, ``None``}, default ``'infer'``
221-
For on-the-fly decompression of on-disk data. If 'infer', then use gzip or bz2
222-
if filepath_or_buffer is a string ending in '.gz' or '.bz2', respectively, and
223-
no decompression otherwise. Set to ``None`` for no decompression.
220+
compression : {``'infer'``, ``'gzip'``, ``'bz2'``, ``'zip'``, ``None``}, default ``'infer'``
221+
For on-the-fly decompression of on-disk data. If 'infer', then use gzip,
222+
bz2 or zip if filepath_or_buffer is a string ending in '.gz', '.bz2' or
223+
'.zip', respectively, and no decompression otherwise. If using 'zip',
224+
the ZIP file must contain only one data file to be read in.
225+
Set to ``None`` for no decompression.
226+
227+
.. versionadded:: 0.18.0 support for 'zip' compression.
228+
224229
thousands : str, default ``None``
225230
Thousands separator.
226231
decimal : str, default ``'.'``

doc/source/whatsnew/v0.18.1.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Enhancements
3333
.. _whatsnew_0181.partial_string_indexing:
3434

3535
Partial string indexing on ``DateTimeIndex`` when part of a ``MultiIndex``
36-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
36+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3737

3838
Partial string indexing now matches on ``DateTimeIndex`` when part of a ``MultiIndex`` (:issue:`10331`)
3939

pandas/io/parsers.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -158,16 +158,15 @@ class ParserWarning(Warning):
158158
information
159159
<http://pandas.pydata.org/pandas-docs/stable/io.html#io-chunking>`_ on
160160
``iterator`` and ``chunksize``.
161-
compression : {'gzip', 'bz2', 'zip', 'infer', None}, default 'infer'
161+
compression : {'infer', 'gzip', 'bz2', 'zip', None}, default 'infer'
162162
For on-the-fly decompression of on-disk data. If 'infer', then use gzip,
163163
bz2 or zip if filepath_or_buffer is a string ending in '.gz', '.bz2' or
164164
'.zip', respectively, and no decompression otherwise. If using 'zip',
165165
the ZIP file must contain only one data file to be read in.
166166
Set to None for no decompression.
167167
168-
.. versionadded:: 0.18.0
168+
.. versionadded:: 0.18.0 support for 'zip' compression.
169169
170-
support for 'zip' compression.
171170
thousands : str, default None
172171
Thousands separator
173172
decimal : str, default '.'

0 commit comments

Comments
 (0)