Skip to content

Commit a733206

Browse files
committed
Update doc of Session
Signed-off-by: Jiahao XU <[email protected]>
1 parent 1895bc7 commit a733206

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/session.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ impl Session {
7373
/// simply pass `None` to `master_log`.
7474
///
7575
/// [`Session`] created this way will not be terminated on drop,
76-
/// but can be forced terminated by [`Session::force_terminate`].
76+
/// but can be forced terminated by [`Session::close`].
7777
///
7878
/// This connects to the ssh multiplex master using process mux impl.
7979
#[cfg(feature = "process-mux")]
@@ -317,6 +317,8 @@ impl Session {
317317
}
318318

319319
/// Terminate the remote connection.
320+
/// It would terminate the ssh multiplex server
321+
/// regardless of how it is created.
320322
pub async fn close(self) -> Result<(), Error> {
321323
delegate!(self.0, imp, { imp.close().await })
322324
}

0 commit comments

Comments
 (0)