Skip to content
This repository was archived by the owner on Jan 13, 2021. It is now read-only.

Commit 5314252

Browse files
committed
Improve connection docstring
1 parent 7a4d51e commit 5314252

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

hyper/http11/connection.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,14 +278,14 @@ def _send_body(self, body, body_type):
278278
def close(self):
279279
"""
280280
Closes the connection. This closes the socket and then abandons the
281-
reference to it. After calling this method, it any outstanding
281+
reference to it. After calling this method, any outstanding
282282
:class:`Response <hyper.http11.response.Response>` objects will throw
283283
exceptions if attempts are made to read their bodies.
284284
285-
This method should absolutely only be called when you are certain the
286-
connection object is no longer needed.
287-
288285
In some cases this method will automatically be called.
286+
287+
.. warning:: This method should absolutely only be called when you are
288+
certain the connection object is no longer needed.
289289
"""
290290
self._sock.close()
291291
self._sock = None

0 commit comments

Comments
 (0)