Skip to content

Commit 101a344

Browse files
committed
Impove _get_handle docstring
1 parent 58ffbce commit 101a344

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

pandas/io/common.py

+16
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,22 @@ def _get_handle(path_or_buf, mode, encoding=None, compression=None,
279279
memory_map=False):
280280
"""
281281
Get file handle for given path/buffer and mode.
282+
283+
Parameters
284+
----------
285+
path_or_buf :
286+
a path (str) or buffer
287+
mode : str
288+
mode to open path_or_buf with
289+
encoding : str or None
290+
compression : str or None
291+
Supported compression protocols are gzip, bz2, zip, and xz
292+
memory_map : boolean, default False
293+
See parsers._parser_params for more information.
294+
295+
Returns
296+
-------
297+
A file like object.
282298
"""
283299

284300
f = path_or_buf

0 commit comments

Comments
 (0)