DOC: Improve _infer_compression docstring

pandas-dev@4a5aec4#commitcomment-20178761
ischurov · Dec 15, 2016 · a7960f6 · a7960f6
1 parent 49e3137
commit a7960f6
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/pandas/io/common.py b/pandas/io/common.py
@@ -247,23 +247,26 @@ def file_path_to_url(path):
 
 def _infer_compression(filepath_or_buffer, compression):
     """
-    Get file handle for given path/buffer and mode.
+    Get the compression method for filepath_or_buffer. If compression='infer',
+    the inferred compression method is returned. Otherwise, the input
+    compression method is returned unchanged, unless it's invalid, in which case
+    an error is raised.
 
     Parameters
     ----------
     filepath_or_buf :
         a path (str) or buffer
-    compression : str, or None
+    compression : str or None
+        the compression method including None for no compression and 'infer'
 
     Returns
     -------
-    string compression method, None
+    string or None :
+        compression method
 
     Raises
     ------
     ValueError on invalid compression specified
-
-    If compression='infer', infer compression. If compression
     """
 
     # No compression has been explicitly specified