[#643] pkg: Sync method names and commentaries to them

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
Pavel Karpy 2021-06-23 16:29:46 +03:00 committed by Alex Vanin
parent 25391111ad
commit 48827f42d3
33 changed files with 41 additions and 41 deletions

View file

@ -31,7 +31,7 @@ func (w *ClientWrapper) PutAuditResult(result *auditAPI.Result) error {
PutAuditResult(args)
}
// ListAuditResults returns a list of all audit result IDs inside audit contract.
// ListAllAuditResultID returns a list of all audit result IDs inside audit contract.
func (w *ClientWrapper) ListAllAuditResultID() ([]ResultID, error) {
args := audit.ListResultsArgs{}

View file

@ -32,7 +32,7 @@ func defaultOpts() *opts {
return new(opts)
}
// TryNotaryInvoke returns option to enable
// TryNotary returns option to enable
// notary invocation tries.
func TryNotary() Option {
return func(o *opts) {

View file

@ -41,7 +41,7 @@ func (p *PutSizeArgs) SetReporterKey(v []byte) {
p.reporterKey = v
}
// Put invokes the call of put container method
// PutSize invokes the call of put container size method
// of NeoFS Container contract.
func (c *Client) PutSize(args PutSizeArgs) error {
err := c.client.Invoke(

View file

@ -278,7 +278,7 @@ type Estimation struct {
Reporter []byte
}
// Estimation is a structure of grouped container load estimation inside Container contract.
// Estimations is a structure of grouped container load estimation inside Container contract.
type Estimations struct {
ContainerID *cid.ID

View file

@ -31,7 +31,7 @@ func defaultOpts() *opts {
return new(opts)
}
// TryNotaryInvoke returns option to enable
// TryNotary returns option to enable
// notary invocation tries.
func TryNotary() Option {
return func(o *opts) {

View file

@ -13,8 +13,8 @@ type ConfigArgs struct {
key []byte
}
// EpochValues groups the stack parameters
// returned by get epoch number test invoke.
// ConfigValues groups the stack parameters
// returned by get config test invoke.
type ConfigValues struct {
val interface{}
}

View file

@ -69,7 +69,7 @@ func (c *Client) NetMap(_ GetNetMapArgs) (*GetNetMapValues, error) {
return peersFromStackItems(prms, c.netMapMethod)
}
// NetMap performs the test invoke of get snapshot of network map
// Snapshot performs the test invoke of get snapshot of network map
// from NeoFS Netmap contract. Contract saves only one previous epoch,
// so all invokes with diff > 1 return error.
func (c *Client) Snapshot(a GetSnapshotArgs) (*GetNetMapValues, error) {

View file

@ -7,7 +7,7 @@ import (
netmap2 "github.com/nspcc-dev/neofs-node/pkg/morph/client/netmap"
)
// Fetch returns current netmap node infos.
// Snapshot returns current netmap node infos.
// Consider using pkg/morph/client/netmap for this.
func (w *Wrapper) Snapshot() (*netmap.Netmap, error) {
res, err := w.client.Snapshot(netmap2.GetSnapshotArgs{})

View file

@ -20,7 +20,7 @@ type (
id ReputationID
}
// GetResults groups the result of "get reputation value" and
// GetResult groups the result of "get reputation value" and
// "get reputation value by reputation id" test invocations.
GetResult struct {
reputations []reputation.GlobalTrust

View file

@ -23,7 +23,7 @@ func defaultOpts() *opts {
return new(opts)
}
// TryNotaryInvoke returns option to enable
// TryNotary returns option to enable
// notary invocation tries.
func TryNotary() Option {
return func(o *opts) {

View file

@ -37,7 +37,7 @@ func defaultStaticOpts() *staticOpts {
return new(staticOpts)
}
// TryNotaryInvoke returns option to enable
// TryNotary returns option to enable
// notary invocation tries.
func TryNotary() StaticClientOption {
return func(o *staticOpts) {