Skip to content

Commit 26a9b4d

Browse files
authored
gh-130902 @Mr-Sunglasses add/update docstring in client.py
Updated the docstring of the close method of the HTTPConnection class to reflect optional shutdown parameter in http/client.py
1 parent 52cd353 commit 26a9b4d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Lib/http/client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,6 +1013,10 @@ def connect(self):
10131013
self._tunnel()
10141014

10151015
def close(self, shutdown=False):
1016+
"""Close the connection to the HTTP server.
1017+
:param shutdown: If True, perform an explicit shutdown of the socket before closing. Defaults to False.
1018+
:type shutdown: bool, optional
1019+
"""
10161020
self.__state = _CS_IDLE
10171021
try:
10181022
sock = self.sock

0 commit comments

Comments
 (0)