wtclient: fix documentation [skip ci]

the implementation also returns exhausted sessions
Thabokani · Oct 17, 2022 · 2a56f60 · 2a56f60
1 parent 2e410dd
commit 2a56f60
Showing 1 changed file with 3 additions and 5 deletions.
diff --git a/watchtower/wtclient/interface.go b/watchtower/wtclient/interface.go
@@ -57,11 +57,9 @@ type DB interface {
 	// restarts.
 	CreateClientSession(*wtdb.ClientSession) error
 
-	// ListClientSessions returns all sessions that have not yet been
-	// exhausted. This is used on startup to find any sessions which may
-	// still be able to accept state updates. An optional tower ID can be
-	// used to filter out any client sessions in the response that do not
-	// correspond to this tower.
+	// ListClientSessions returns the set of all client sessions known to
+	// the db. An optional tower ID can be used to filter out any client
+	// sessions in the response that do not correspond to this tower.
 	ListClientSessions(*wtdb.TowerID, ...wtdb.ClientSessionListOption) (
 		map[wtdb.SessionID]*wtdb.ClientSession, error)