From f34c99d538adb82317c2406a28f193373b7bdf72 Mon Sep 17 00:00:00 2001 From: Evgenii Baidakov Date: Fri, 5 May 2023 10:14:38 +0400 Subject: [PATCH] docs: Actualize interfaces in status structs Signed-off-by: Evgenii Baidakov --- client/status/common.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/client/status/common.go b/client/status/common.go index 3093e9b..a17c732 100644 --- a/client/status/common.go +++ b/client/status/common.go @@ -7,7 +7,7 @@ import ( ) // ServerInternal describes failure statuses related to internal server errors. -// Instances provide Status and StatusV2 interfaces. +// Instances provide [Status], [StatusV2] and error interfaces. // // The status is purely informative, the client should not go into details of the error except for debugging needs. type ServerInternal struct { @@ -57,7 +57,7 @@ func WriteInternalServerErr(x *ServerInternal, err error) { } // WrongMagicNumber describes failure status related to incorrect network magic. -// Instances provide Status and StatusV2 interfaces. +// Instances provide [Status], [StatusV2] and error interfaces. type WrongMagicNumber struct { v2 status.Status } @@ -125,7 +125,7 @@ func (x WrongMagicNumber) CorrectMagic() (magic uint64, ok int8) { } // SignatureVerification describes failure status related to signature verification. -// Instances provide Status and StatusV2 interfaces. +// Instances provide [Status], [StatusV2] and error interfaces. type SignatureVerification struct { v2 status.Status } @@ -183,7 +183,7 @@ func (x SignatureVerification) Message() string { } // NodeUnderMaintenance describes failure status for nodes being under maintenance. -// Instances provide Status and StatusV2 interfaces. +// Instances provide [Status], [StatusV2] and error interfaces. type NodeUnderMaintenance struct { v2 status.Status }