Add some comments for 1148118271#91

src/session/mod.rs

@@ -142,6 +142,10 @@ impl SessionBuilder {
     }
 
     /// Read/Write timeout for local SSH mode. Use None to disable timeout.
+    /// This is a global timeout only take effect after the session is established
+    ///
+    /// Use `connect_with_timeout` instead if you want to add timeout
+    /// when connect to the target SSH server
     pub fn timeout(mut self, timeout: Option<Duration>) -> Self {
         self.config.timeout = timeout;
         self
@@ -241,6 +245,8 @@ impl SessionBuilder {
         self
     }
 
+    /// Create a TCP connection to the target server
+    ///
     pub fn connect<A>(self, addr: A) -> SshResult<SessionConnector<TcpStream>>
     where
         A: ToSocketAddrs,
@@ -257,6 +263,8 @@ impl SessionBuilder {
         self.connect_bio(tcp)
     }
 
+    /// Create a TCP connection to the target server, with timeout provided
+    ///
     pub fn connect_with_timeout<A>(
         self,
         addr: A,