Document a possible way in which connect_timout may change in the future

rust-lang · May 13, 2014 · 8252353 · 8252353
1 parent 611c2ae
commit 8252353
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/libstd/io/net/tcp.rs b/src/libstd/io/net/tcp.rs
@@ -95,6 +95,9 @@ impl TcpStream {
     /// This is the same as the `connect` method, except that if the timeout
     /// specified (in milliseconds) elapses before a connection is made an error
     /// will be returned. The error's kind will be `TimedOut`.
+    ///
+    /// Note that the `addr` argument may one day be split into a separate host
+    /// and port, similar to the API seen in `connect`.
     #[experimental = "the timeout argument may eventually change types"]
     pub fn connect_timeout(addr: SocketAddr,
                            timeout_ms: u64) -> IoResult<TcpStream> {