From 68a18c4dbc8589a6cffcf16626e3d57633b32463 Mon Sep 17 00:00:00 2001
From: benaryorg <binary@benary.org>
Date: Sat, 23 Apr 2016 17:50:16 +0200
Subject: [PATCH] clarify documentation of TcpStream::connect() for multiple
 valid addresses

Signed-off-by: benaryorg <binary@benary.org>
---
 src/libstd/net/tcp.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/libstd/net/tcp.rs b/src/libstd/net/tcp.rs
index 38da74b89039b..9265705fac084 100644
--- a/src/libstd/net/tcp.rs
+++ b/src/libstd/net/tcp.rs
@@ -86,6 +86,8 @@ impl TcpStream {
     /// `addr` is an address of the remote host. Anything which implements
     /// `ToSocketAddrs` trait can be supplied for the address; see this trait
     /// documentation for concrete examples.
+    /// In case `ToSocketAddrs::to_socket_addrs()` returns more than one entry,
+    /// then the first valid and reachable address is used.
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn connect<A: ToSocketAddrs>(addr: A) -> io::Result<TcpStream> {
         super::each_addr(addr, net_imp::TcpStream::connect).map(TcpStream)