godoc: update godoc of solomachine status method

cosmos · May 7, 2024 · 5b22771 · 5b22771
1 parent eeb031b
commit 5b22771
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/modules/light-clients/06-solomachine/light_client_module.go b/modules/light-clients/06-solomachine/light_client_module.go
@@ -169,8 +169,9 @@ func (l LightClientModule) VerifyNonMembership(
 
 // Status returns the status of the solo machine client.
 // The client may be:
-// - Active: if frozen sequence is 0
-// - Frozen: otherwise solo machine is frozen
+// - Active: if `IsFrozen` is false.
+// - Frozen: if `IsFrozen` is true.
+// - Unknown: if the client state associated with the provided client identifier is not found.
 //
 // CONTRACT: clientID is validated in 02-client router, thus clientID is assumed here to have the format 06-solomachine-{n}.
 func (l LightClientModule) Status(ctx sdk.Context, clientID string) exported.Status {