diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2023-05-24 20:56:31 -0400 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2023-05-24 20:56:31 -0400 |
| commit | 8127be0f8ba16e5e4532e4b8e39d393e2048378e (patch) | |
| tree | ecd15e6b2690de830512e61870c82fd4e89919a7 | |
| parent | 55944c8c1a26baf216eecc2646916f145a55560a (diff) | |
Docstring tweak
| -rw-r--r-- | paramiko/client.py | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/paramiko/client.py b/paramiko/client.py index 2d14f362..d8be9108 100644 --- a/paramiko/client.py +++ b/paramiko/client.py @@ -326,10 +326,14 @@ class SSHClient(ClosingContextManager): `.Transport.__init__`. :param auth_strategy: an optional instance of `.AuthStrategy`, triggering use of this - newer authentication mechanism. This parameter is **incompatible** - with all other authentication-related parameters (such as, but not - limited to, ``password``, ``key_filename`` and ``allow_agent``) and - will trigger an exception if given alongside them. + newer authentication mechanism instead of SSHClient's legacy auth + method. + + .. warning:: + This parameter is **incompatible** with all other + authentication-related parameters (such as, but not limited to, + ``password``, ``key_filename`` and ``allow_agent``) and will + trigger an exception if given alongside them. :returns: `.AuthResult` if ``auth_strategy`` is non-``None``; otherwise, |