X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/44c95f99098fa6c6acbfa82d4b6cbc6015eb6e39..093ec98e4a065acfc537ea22c08c337c115fe273:/sdk/go/blockdigest/blockdigest.go diff --git a/sdk/go/blockdigest/blockdigest.go b/sdk/go/blockdigest/blockdigest.go index b9ecc45abc..ecb09964ec 100644 --- a/sdk/go/blockdigest/blockdigest.go +++ b/sdk/go/blockdigest/blockdigest.go @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -// Stores a Block Locator Digest compactly. Can be used as a map key. +// Package blockdigest stores a Block Locator Digest compactly. Can be used as a map key. package blockdigest import ( @@ -15,8 +15,8 @@ import ( var LocatorPattern = regexp.MustCompile( "^[0-9a-fA-F]{32}\\+[0-9]+(\\+[A-Z][A-Za-z0-9@_-]*)*$") -// Stores a Block Locator Digest compactly, up to 128 bits. -// Can be used as a map key. +// BlockDigest stores a Block Locator Digest compactly, up to 128 bits. Can be +// used as a map key. type BlockDigest struct { H uint64 L uint64 @@ -41,7 +41,7 @@ func (w DigestWithSize) String() string { return fmt.Sprintf("%s+%d", w.Digest.String(), w.Size) } -// Will create a new BlockDigest unless an error is encountered. +// FromString creates a new BlockDigest unless an error is encountered. func FromString(s string) (dig BlockDigest, err error) { if len(s) != 32 { err = fmt.Errorf("Block digest should be exactly 32 characters but this one is %d: %s", len(s), s)