summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2023-05-18 15:19:00 -0400
committerJeff Forcier <jeff@bitprophet.org>2023-05-22 12:22:05 -0400
commitb0caad4a7df909a2b52c18c330afa18dc02814da (patch)
tree0f4a3931b9c3cd7d2ef1114bd2bef132c95d1c2f
parentaf67bb86b071c2714442670ce193f2fb21d7abcd (diff)
Fix up dangling refs to aborted new doc
-rw-r--r--paramiko/client.py11
-rw-r--r--sites/www/changelog.rst4
2 files changed, 7 insertions, 8 deletions
diff --git a/paramiko/client.py b/paramiko/client.py
index 461dbb07..2d14f362 100644
--- a/paramiko/client.py
+++ b/paramiko/client.py
@@ -325,12 +325,11 @@ class SSHClient(ClosingContextManager):
`.Transport` instance to be used by this client. Defaults to
`.Transport.__init__`.
:param auth_strategy:
- an optional instance of `.AuthStrategy`, triggering use of the
- newer authentication mechanism (see :ref:`auth-flow`). 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.
+ 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.
:returns:
`.AuthResult` if ``auth_strategy`` is non-``None``; otherwise,
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst
index bdd2d426..ff59a865 100644
--- a/sites/www/changelog.rst
+++ b/sites/www/changelog.rst
@@ -57,8 +57,8 @@ Changelog
- :feature:`387` Users of `~paramiko.client.SSHClient` can now configure the
authentication logic Paramiko uses when connecting to servers; this
functionality is intended for advanced users and higher-level libraries such
- as `Fabric <https://fabfile.org>`_. See :ref:`the conceptual API docs
- <auth-flow>` for details.
+ as `Fabric <https://fabfile.org>`_. See `~paramiko.auth_strategy` for
+ details.
Fabric's co-temporal release includes a proof-of-concept use of this feature,
implementing an auth flow much closer to that of the OpenSSH client (versus