Skip to content

Commit 2dc1f2f

Browse files
committed
Clean up docstring
1 parent 10652a0 commit 2dc1f2f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pandas/io/common.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -141,18 +141,18 @@ def _is_s3_url(url):
141141

142142

143143
def maybe_read_encoded_stream(reader, encoding=None, compression=None):
144-
"""read an encoded stream from the reader and transform the bytes to
145-
unicode if required based on the encoding
146-
147-
Parameters
148-
----------
149-
reader : a streamable file-like object
150-
encoding : optional, the encoding to attempt to read
144+
"""
145+
Read an encoded stream from the reader and transform the bytes to unicode if
146+
required based on the encoding.
151147
152-
Returns
153-
-------
154-
a tuple of (a stream of decoded bytes, the encoding which was used)
148+
Parameters
149+
----------
150+
reader : a streamable file-like object
151+
encoding : optional, the encoding to attempt to read
155152
153+
Returns
154+
-------
155+
a tuple of (a stream of decoded bytes, the encoding which was used)
156156
"""
157157

158158
if compat.PY3 or encoding is not None: # pragma: no cover

0 commit comments

Comments
 (0)