From 5b227717288eece993bcd9af85dc4cf7908fab8a Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Tue, 7 May 2024 10:20:16 +0200 Subject: [PATCH] godoc: update godoc of solomachine status method --- modules/light-clients/06-solomachine/light_client_module.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/light-clients/06-solomachine/light_client_module.go b/modules/light-clients/06-solomachine/light_client_module.go index 7a41f7c1f7a..2e8f2d9fc99 100644 --- 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 {