summaryrefslogtreecommitdiff
path: root/paramiko/server.py
diff options
context:
space:
mode:
authorJamie Bliss <jbliss@purestorage.com>2023-02-24 18:48:51 -0500
committerJamie Bliss <jbliss@purestorage.com>2023-02-24 18:48:51 -0500
commite87d0c986efacfccb2e1b8a1919e08249c4ae0de (patch)
treead9aba916b54b19439d65d930350e12b99387a26 /paramiko/server.py
parent4ced4229b67d7e6e93e8e0ea0431d52075fbbaa3 (diff)
downloadparamiko-e87d0c986efacfccb2e1b8a1919e08249c4ae0de.tar.gz
Expand documentation on server agent handling.
Diffstat (limited to 'paramiko/server.py')
-rw-r--r--paramiko/server.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/paramiko/server.py b/paramiko/server.py
index 3875b8a2..db819a83 100644
--- a/paramiko/server.py
+++ b/paramiko/server.py
@@ -517,6 +517,9 @@ class ServerInterface:
:param .Channel channel: the `.Channel` the request arrived on
:return: ``True`` if the AgentForward was loaded; ``False`` if not
+
+ If ``True`` is returned, the server should create an :class:`AgentServerProxy`
+ to access the agent.
"""
return False