Clean up docstring · pandas-dev/pandas@2dc1f2f (original) (raw)

Original file line number Diff line number Diff line change
@@ -141,18 +141,18 @@ def _is_s3_url(url):
141 141
142 142
143 143 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.
151 147
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
155 152
153 + Returns
154 + -------
155 + a tuple of (a stream of decoded bytes, the encoding which was used)
156 156 """
157 157
158 158 if compat.PY3 or encoding is not None: # pragma: no cover