Improve docs/examples

pandas-dev · WillAyd · Aug 26, 2019 · Apr 8, 2019 · Apr 8, 2019 · Apr 8, 2019
commit 18a735dbf16a62c802cfd6afad4fcd1c9857c91d
diff --git a/doc/source/whatsnew/v0.25.0.rst b/doc/source/whatsnew/v0.25.0.rst
@@ -37,7 +37,7 @@ Other Enhancements
 - :class:`RangeIndex` has gained :attr:`~RangeIndex.start`, :attr:`~RangeIndex.stop`, and :attr:`~RangeIndex.step` attributes (:issue:`25710`)
 - :class:`datetime.timezone` objects are now supported as arguments to timezone methods and constructors (:issue:`25065`)
 - :meth:`DataFrame.query` and :meth:`DataFrame.eval` now supports quoting column names with backticks to refer to names with spaces (:issue:`6508`)
-- :meth:`DataFrame.to_csv` and :meth:`Series.to_csv` now support dicts as ``compression`` argument with key ``'method'`` being the compression method and others as kwargs of ``ByteZipFile`` when the compression method is ``'zip'``. (:issue:`26023`)
+- :meth:`DataFrame.to_csv` and :meth:`Series.to_csv` now support dicts as ``compression`` argument with key ``'method'`` being the compression method and others as additional compression options when the compression method is ``'zip'``. (:issue:`26023`)
 
 .. _whatsnew_0250.api_breaking:
 

diff --git a/pandas/core/generic.py b/pandas/core/generic.py
@@ -2970,13 +2970,14 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
             detect compression mode from the following extensions: '.gz',
             '.bz2', '.zip' or '.xz'. (otherwise no compression). If dict given
             and mode is 'zip' or inferred as 'zip', other entries passed as
-            kwargs to ByteZipFile.
+            additional compression options.
 
             .. versionchanged:: 0.25.0
 
                May now be a dict with key 'method' as compression mode
-               and other entries as ByteZipFile kwargs if compression mode
-               is 'zip'
+               and other entries as additional compression options if
+               compression mode is 'zip'.
+
         quoting : optional constant from csv module
             Defaults to csv.QUOTE_MINIMAL. If you have set a `float_format`
             then floats are converted to strings and thus csv.QUOTE_NONNUMERIC
@@ -3028,10 +3029,10 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
         ...                    'weapon': ['sai', 'bo staff']})
         >>> df.to_csv(index=False)
         'name,mask,weapon\nRaphael,red,sai\nDonatello,purple,bo staff\n'
+
+        # create 'out.zip' containing 'out.csv'
         >>> compression_opts = dict(method='zip', archive_name='out.csv')
         >>> df.to_csv('out.zip', index=False, compression=compression_opts)
-
-        # creates 'out.zip' containing 'out.csv'
         """
 
         df = self if isinstance(self, ABCDataFrame) else self.to_frame()

diff --git a/pandas/io/common.py b/pandas/io/common.py
@@ -338,12 +338,12 @@ def _get_handle(path_or_buf, mode, encoding=None,
         and `filepath_or_buffer` is path-like, then detect compression from
         the following extensions: '.gz', '.bz2', '.zip', or '.xz' (otherwise
         no compression). If dict and compression mode is 'zip' or inferred as
-        'zip', other entries passed as kwargs to ByteZipFile.
+        'zip', other entries passed as additional compression options.
 
         .. versionchanged:: 0.25.0
 
            May now be a dict with key 'method' as compression mode
-           and other keys as kwargs for ByteZipFile if compression
+           and other keys as compression options if compression
            mode is 'zip'.
 
     memory_map : boolean, default False