summaryrefslogtreecommitdiffhomepage
path: root/tests/_util.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2023-12-15 21:59:18 -0500
committerJeff Forcier <jeff@bitprophet.org>2023-12-15 22:00:12 -0500
commit352531f803e55e8a5186cd928543279ad1585893 (patch)
treedad7290789c07e891e9085dece81665e140fd6ec /tests/_util.py
parent041779387e7106925f152dfef76568d885fa1c3b (diff)
Document a test util func a bit
Diffstat (limited to 'tests/_util.py')
-rw-r--r--tests/_util.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/tests/_util.py b/tests/_util.py
index eaf6aac4..aeee96ea 100644
--- a/tests/_util.py
+++ b/tests/_util.py
@@ -352,6 +352,9 @@ def server(
"""
SSH server contextmanager for testing.
+ Yields a tuple of ``(tc, ts)`` (client- and server-side `Transport`
+ objects), or ``(tc, ts, err)`` when ``catch_error==True``.
+
:param hostkey:
Host key to use for the server; if None, loads
``rsa.key``.