Add UpgradeCompleted effect to observer doc

elastic · Oct 13, 2023 · 978b309 · 978b309
1 parent c3b031a
commit 978b309
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/internal/pkg/agent/application/upgrade/details/details.go b/internal/pkg/agent/application/upgrade/details/details.go
@@ -73,7 +73,8 @@ func (d *Details) RegisterObserver(observer Observer) {
 }
 
 // NotifyObservers sends the current upgrade details to all registered
-// observers.
+// observers. When an upgrade has completed (StateCompleted), the observers
+// will be sent a nil value.
 func (d *Details) NotifyObservers() {
 	d.mu.RLock()
 	defer d.mu.RUnlock()