docs: Actualize interfaces in status structs

Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
This commit is contained in:
Evgenii Baidakov 2023-05-05 10:14:38 +04:00
parent ca0f19c453
commit f34c99d538
No known key found for this signature in database
GPG key ID: 8733EE3D72CDB4DE

View file

@ -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
}