Skip to content

Commit dce054e

Browse files
committed
Clean up docstring
1 parent 064c1b3 commit dce054e

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
@@ -139,18 +139,18 @@ def _is_s3_url(url):
139139

140140

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

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

0 commit comments

Comments
 (0)