diff options
| author | Red_M <pooatyou.com@gmail.com> | 2018-05-20 19:09:21 +1000 |
|---|---|---|
| committer | Red_M <pooatyou.com@gmail.com> | 2018-05-20 19:09:21 +1000 |
| commit | 6b741f9152802aceb96d610cdedcff7a6378ec3f (patch) | |
| tree | d0c6f71045255cd86f898927dc196f191f33fa39 | |
| parent | f8db03098412006e21e7d5ec1ed0d453c3d749ce (diff) | |
| download | pexpect-6b741f9152802aceb96d610cdedcff7a6378ec3f.tar.gz | |
Update doc string as per #489.
| -rw-r--r-- | pexpect/pxssh.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/pexpect/pxssh.py b/pexpect/pxssh.py index 8d3a48c..79cf7f2 100644 --- a/pexpect/pxssh.py +++ b/pexpect/pxssh.py @@ -294,7 +294,9 @@ class pxssh (spawn): session to do so. Setting this option to `False` and not having an active session will trigger an error. - Set ``ssh_key`` to `True` to force passing the current SSH authentication socket to the + Set ``ssh_key`` to a string that is a file path to an SSH private key. Doing so + will use that SSH key for the session authentication. + Set ``ssh_key`` to `True` to force passing the current SSH authentication socket to the desired ``hostname``. ''' |