[#322] *: Go fmt -s

go1.19 rewrites comments to proper render them in docs.

Signed-off-by: Evgenii Stratonikov <evgeniy@nspcc.ru>
This commit is contained in:
Evgenii Stratonikov 2022-08-24 17:17:40 +03:00 committed by fyrchik
parent 7537fa0dec
commit 84888854ab
69 changed files with 272 additions and 219 deletions

View file

@ -5,9 +5,11 @@ The main component is Client type. It is a virtual connection to the network
and provides methods for executing operations on the server.
Create client instance:
var c client.Client
Initialize client state:
var prm client.PrmInit
prm.SetDefaultPrivateKey(key)
// ...
@ -15,6 +17,7 @@ Initialize client state:
c.Init(prm)
Connect to the NeoFS server:
var prm client.PrmDial
prm.SetServerURI("localhost:8080")
prm.SetDefaultPrivateKey(key)
@ -24,6 +27,7 @@ Connect to the NeoFS server:
// ...
Execute NeoFS operation on the server:
var prm client.PrmContainerPut
prm.SetContainer(cnr)
// ...
@ -36,6 +40,7 @@ Execute NeoFS operation on the server:
// ...
Consume custom service of the server:
syntax = "proto3";
service CustomService {
@ -58,6 +63,7 @@ Consume custom service of the server:
// ...
Close the connection:
err := c.Close()
// ...
@ -65,6 +71,7 @@ Note that it's not allowed to override Client behaviour directly: the parameters
for the all operations are write-only and the results of the all operations are
read-only. To be able to override client behavior (e.g. for tests), abstract it
with an interface:
import "github.com/nspcc-dev/neofs-sdk-go/client"
type NeoFSClient interface {
@ -80,6 +87,5 @@ with an interface:
func (x *client) CreateContainer(context.Context, container.Container) error {
// ...
}
*/
package client