JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

satellite/metainfo: Fix some docs comments

Browse Source 
Fix a documentation comment for one method and apply our code
conventions to some that I stumbled.

Change-Id: I3baf5d004a128dcd561c3e27c080aab345c64461
This commit is contained in:
Ivan Fraixedes 2019-12-06 19:14:35 +01:00
parent 1df7b360d7
commit c400471bbc
No known key found for this signature in database
GPG Key ID: 042B474597F96DB7
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
satellite/metainfo/metainfo.go
View File

@ -1143,7 +1143,8 @@ func (endpoint *Endpoint) BeginObject(ctx context.Context, req *pb.ObjectBeginRe
}, nil
}
// CommitObject commits object when all segments are also committed
// CommitObject commits an object when all its segments have already been
// committed.
func (endpoint *Endpoint) CommitObject(ctx context.Context, req *pb.ObjectCommitRequest) (resp *pb.ObjectCommitResponse, err error) {
defer mon.Task()(&ctx)(&err)

4
satellite/metainfo/service.go
View File

@ -27,12 +27,12 @@ type Service struct {
bucketsDB BucketsDB
}
// NewService creates new metainfo service
// NewService creates new metainfo service.
func NewService(logger *zap.Logger, db PointerDB, bucketsDB BucketsDB) *Service {
return &Service{logger: logger, db: db, bucketsDB: bucketsDB}
}
// Put puts pointer to db under specific path
// Put puts pointer to db under specific path.
func (s *Service) Put(ctx context.Context, path string, pointer *pb.Pointer) (err error) {
defer mon.Task()(&ctx)(&err)