summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorWez Furlong <wez@wezfurlong.org>2019-10-20 08:45:34 +0100
committerWez Furlong <wez@wezfurlong.org>2019-10-20 09:36:31 +0100
commite1c6085b4a0a665915bb00b6cb69e6c28950015e (patch)
tree3385024f8ef2487748b7d19b5fc5cbc05fb047a2 /src
parentad38a85b222c8631eae8595e52a777fa148561aa (diff)
downloadssh2-rs-e1c6085b4a0a665915bb00b6cb69e6c28950015e.zip
fixup documentation on Session::new
Refs: https://github.com/alexcrichton/ssh2-rs/issues/137
Diffstat (limited to 'src')
-rw-r--r--src/session.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/session.rs b/src/session.rs
index 9babdd2..1009b2c 100644
--- a/src/session.rs
+++ b/src/session.rs
@@ -90,8 +90,9 @@ impl Session {
/// This function does not associate the session with a remote connection
/// just yet. Various configuration options can be set such as the blocking
/// mode, compression, sigpipe, the banner, etc. To associate this session
- /// with a TCP connection, use the `handshake` method to pass in an
- /// already-established TCP socket.
+ /// with a TCP connection, use the `set_tcp_stream` method pass in an
+ /// already-established TCP socket, and then follow up with a call to
+ /// `handshake` to perform the ssh protocol handshake.
pub fn new() -> Result<Session, Error> {
::init();
unsafe {