From b61c3f9d04bad1afc20a69ad1e6e2ae6da9c904b Mon Sep 17 00:00:00 2001 From: Mikhail Zabaluev Date: Mon, 29 Jun 2020 16:05:11 +0300 Subject: [PATCH] Update libp2p-dns doc to include /dns/ support (#1634) Now that /dns/ is supported, it should be mentioned in the documentation as well. --- transports/dns/src/lib.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/transports/dns/src/lib.rs b/transports/dns/src/lib.rs index 82e54151..b9bd3763 100644 --- a/transports/dns/src/lib.rs +++ b/transports/dns/src/lib.rs @@ -29,8 +29,8 @@ //! implementation of the `Transport` trait. //! //! Whenever we want to dial an address through the `DnsConfig` and that address contains a -//! `/dns4/` or `/dns6/` component, a DNS resolve will be performed and the component will be -//! replaced with respectively an `/ip4/` or an `/ip6/` component. +//! `/dns/`, `/dns4/`, or `/dns6/` component, a DNS resolve will be performed and the component +//! will be replaced with `/ip4/` and/or `/ip6/` components. //! use futures::{prelude::*, channel::oneshot, future::BoxFuture}; @@ -45,8 +45,8 @@ use std::{error, fmt, io, net::ToSocketAddrs}; /// Represents the configuration for a DNS transport capability of libp2p. /// /// This struct implements the `Transport` trait and holds an underlying transport. Any call to -/// `dial` with a multiaddr that contains `/dns4/` or `/dns6/` will be first be resolved, then -/// passed to the underlying transport. +/// `dial` with a multiaddr that contains `/dns/`, `/dns4/`, or `/dns6/` will be first be resolved, +/// then passed to the underlying transport. /// /// Listening is unaffected. #[derive(Clone)]