Skip to content

Commit 96aa39f

Browse files
committed
Rephrase _prepare_socket docstring to avoid spell check failures
Describe the return tuple in plain prose to avoid abbreviations that the spell checker flags.
1 parent 050a198 commit 96aa39f

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

cheroot/connections.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -392,12 +392,11 @@ def _configure_socket(self, sock):
392392
def _prepare_socket(self, server_socket):
393393
"""Handle physical accept and TLS negotiation.
394394
395-
Returns (sock, addr, makefile, ssl_env) where sock is the accepted
396-
socket (possibly TLS-wrapped), addr is the remote (ip, port), makefile
397-
is a callable that wraps the socket for buffered reading, and ssl_env
398-
is a dict of TLS metadata (empty if not using TLS).
399-
Raises _NoConnectionAvailable if no connection is ready to accept.
400-
Raises ConnectionError if TLS negotiation fails.
395+
Returns a 4-tuple of the accepted socket (possibly TLS-wrapped),
396+
the remote address and port, a callable that wraps the socket for
397+
buffered reading, and a dict of TLS metadata (empty if not using TLS).
398+
Raises ``_NoConnectionAvailable`` if no connection is ready to accept.
399+
Raises ``ConnectionError`` if TLS negotiation fails.
401400
"""
402401
result = self._accept_conn(server_socket)
403402
if result is None:

0 commit comments

Comments
 (0)