about summary refs log tree commit diff
path: root/src/libstd/net/mod.rs
diff options
context:
space:
mode:
authorlukaramu <lukaramu@gmail.com>2017-03-27 16:38:17 +0200
committerlukaramu <lukaramu@gmail.com>2017-03-27 16:38:17 +0200
commitb8cbc5d46af4b15bfeca324aa37d8c2ca054e58e (patch)
tree14caf1e7736195735b9b6d82f0c04e62e4fab515 /src/libstd/net/mod.rs
parentc2601fd358769cbecae479e8d32521f6e5d5c633 (diff)
downloadrust-b8cbc5d46af4b15bfeca324aa37d8c2ca054e58e.tar.gz
rust-b8cbc5d46af4b15bfeca324aa37d8c2ca054e58e.zip
Addressed requested changes for PR #40838
* Fixed spelling ToSocketAddr -> ToSocketAddrs in module docs
  (which also fixes a link)
* Added missing "when" before "interacting" in module docs
* Changed SocketAddr's top-level docs to explicitly state what socket
  addresses consist of, making them more consistent with SocketAddrV4's
  and SocketAddrV6's docs
* Changed "in C" -> "in C's `netinet/in.h`"
* Changed wording in is_ipv4/is_ipv6 methods to ", `false` otherwise"
* Add missing closing ` ``` ` in Ipv6Addr's examples
* Removed "Errors" section in ToSocketAddrs' to_socket_addrs method as it
  was rather redundant
Diffstat (limited to 'src/libstd/net/mod.rs')
-rw-r--r--src/libstd/net/mod.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libstd/net/mod.rs b/src/libstd/net/mod.rs
index 3b4808fee25..9fcb93e2032 100644
--- a/src/libstd/net/mod.rs
+++ b/src/libstd/net/mod.rs
@@ -21,7 +21,7 @@
 //!   [`Ipv6Addr`] are respectively IPv4 and IPv6 addresses
 //! * [`SocketAddr`] represents socket addresses of either IPv4 or IPv6; [`SocketAddrV4`]
 //!   and [`SocketAddrV6`] are respectively IPv4 and IPv6 socket addresses
-//! * [`ToSocketAddr`] is a trait that used for generic address resolution interacting
+//! * [`ToSocketAddrs`] is a trait that used for generic address resolution when interacting
 //!   with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
 //! * Other types are return or parameter types for various methods in this module
 //!
@@ -33,7 +33,7 @@
 //! [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
 //! [`TcpListener`]: ../../std/net/struct.TcpListener.html
 //! [`TcpStream`]: ../../std/net/struct.TcpStream.html
-//! [`ToSocketAddr`]: ../../std/net/trait.ToSocketAddr.html
+//! [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
 //! [`UdpSocket`]: ../../std/net/struct.UdpSocket.html
 
 #![stable(feature = "rust1", since = "1.0.0")]