Document that connect_isolated only works on mainnet

Document that connect_isolated only works on mainnet. See #1687.
ZcashFoundation · Feb 4, 2021 · 1e156a5 · 1e156a5
1 parent bf42e46
commit 1e156a5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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,