From 978b309a66e86909f0fbb4b906c4daf29ac8dc2c Mon Sep 17 00:00:00 2001
From: Shaunak Kashyap <ycombinator@gmail.com>
Date: Thu, 5 Oct 2023 04:58:32 -0700
Subject: [PATCH] Add UpgradeCompleted effect to observer doc

---
 internal/pkg/agent/application/upgrade/details/details.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/internal/pkg/agent/application/upgrade/details/details.go b/internal/pkg/agent/application/upgrade/details/details.go
index 7a09763b786..a7310e6813d 100644
--- 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()