Skip to content

Commit bc54e46

Browse files
committed
Impove _get_handle docstring
1 parent 673bde0 commit bc54e46

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
@@ -277,6 +277,22 @@ def _get_handle(path_or_buf, mode, encoding=None, compression=None,
277277
memory_map=False):
278278
"""
279279
Get file handle for given path/buffer and mode.
280+
281+
Parameters
282+
----------
283+
path_or_buf :
284+
a path (str) or buffer
285+
mode : str
286+
mode to open path_or_buf with
287+
encoding : str or None
288+
compression : str or None
289+
Supported compression protocols are gzip, bz2, zip, and xz
290+
memory_map : boolean, default False
291+
See parsers._parser_params for more information.
292+
293+
Returns
294+
-------
295+
A file like object.
280296
"""
281297

282298
f = path_or_buf

0 commit comments

Comments
 (0)