Merge clarify-conch-preferredOrder-6850

Author: veloutin Reviewer: hynek Fixes: twisted#6850 Clarify the meaning of the preferredOrder ivar of twisted.conch.ssh.userauth.SSHUserAuthClient. git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@41213 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
jacobrichard · Jan 12, 2014 · c4716c4 · c4716c4
1 parent 2e671a5
commit c4716c4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/twisted/conch/ssh/userauth.py b/twisted/conch/ssh/userauth.py
@@ -394,11 +394,13 @@ class SSHUserAuthClient(service.SSHService):
     """
     A service implementing the client side of 'ssh-userauth'.
 
+    This service will try all authentication methods provided by the server,
+    making callbacks for more information when necessary.
+
     @ivar name: the name of this service: 'ssh-userauth'
     @type name: C{str}
-    @ivar preferredOrder: a list of authentication methods we support, in
-        order of preference.  The client will try authentication methods in
-        this order, making callbacks for information when necessary.
+    @ivar preferredOrder: a list of authentication methods that should be used
+        first, in order of preference, if supported by the server
     @type preferredOrder: C{list}
     @ivar user: the name of the user to authenticate as
     @type user: C{str}

diff --git a/twisted/conch/topfiles/6850.doc b/twisted/conch/topfiles/6850.doc
@@ -0,0 +1 @@
+The docstring for twisted.conch.ssh.userauth.SSHUserAuthClient is now clearer on how the preferredOrder instance variable is handled.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The docstring for twisted.conch.ssh.userauth.SSHUserAuthClient is now clearer on how the preferredOrder instance variable is handled.