From 6c06acc02cbb89a1208a4427a253233cbfe0ea21 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 28 Jun 2023 08:32:59 -0400
Subject: [PATCH] arti_client: Add a warning comment to TorAddrError.

---
 crates/arti-client/src/address.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/crates/arti-client/src/address.rs b/crates/arti-client/src/address.rs
index 8d6023299..f4339d108 100644
--- a/crates/arti-client/src/address.rs
+++ b/crates/arti-client/src/address.rs
@@ -344,6 +344,9 @@ impl std::fmt::Display for TorAddr {
 }
 
 /// An error created while making or using a [`TorAddr`].
+//
+// NOTE: Unlike ErrorDetail, this is a `pub` enum: Do not make breaking changes
+// to it, or expose lower-level errors in it, without careful consideration!
 #[derive(Debug, Error, Clone, Eq, PartialEq)]
 #[non_exhaustive]
 // TODO Should implement ErrorKind