From 3b45391f5c34ddace3d119a5d2378691414596c5 Mon Sep 17 00:00:00 2001
From: Sean Klein <sean@oxide.computer>
Date: Tue, 13 Feb 2024 12:53:28 -0800
Subject: [PATCH] Comments

---
 sled-agent/src/sled_agent.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/sled-agent/src/sled_agent.rs b/sled-agent/src/sled_agent.rs
index a21fc79f9b..1a634a6346 100644
--- a/sled-agent/src/sled_agent.rs
+++ b/sled-agent/src/sled_agent.rs
@@ -669,9 +669,11 @@ impl SledAgent {
         Ok(())
     }
 
-    /// Sends a request to Nexus informing it that the current sled exists.
+    /// Sends a request to Nexus informing it that the current sled exists,
+    /// with information abou the existing set of hardware.
     ///
-    /// Does not block for neux being available.
+    /// Does not block until Nexus is available -- the future created by this
+    /// function is retried in a queue that is polled in the background.
     pub(crate) fn notify_nexus_about_self(&self, log: &Logger) {
         let sled_id = self.inner.id;
         let nexus_client = self.inner.nexus_client.clone();