Document that connect_isolated only works on mainnet

Document that connect_isolated only works on mainnet. See #1687.
2021-02-05 08:11:21 +10:00 · 2021-02-05 08:11:21 +10:00 · 1e156a5d60
parent bf42e468fc
commit 1e156a5d60
1 changed files with 4 additions and 0 deletions
--- a/zebra-network/src/isolated.rs
+++ b/zebra-network/src/isolated.rs
@ -35,6 +35,10 @@ use crate::{peer, BoxError, Config, Request, Response};
 /// connection allows this method to be used with clearnet or Tor transports.
 ///
 /// - `user_agent`: a valid BIP14 user-agent, e.g., the empty string.
+///
+/// # Bug
+///
+/// `connect_isolated` only works on `Mainnet`, see #1687.
 pub fn connect_isolated(
    conn: TcpStream,
    user_agent: String,