From 352531f803e55e8a5186cd928543279ad1585893 Mon Sep 17 00:00:00 2001
From: Jeff Forcier <jeff@bitprophet.org>
Date: Fri, 15 Dec 2023 21:59:18 -0500
Subject: Document a test util func a bit

---
 tests/_util.py | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'tests/_util.py')

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``.
-- 
cgit v1.2.3