diff options
| author | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-16 18:45:45 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-17 02:51:43 -0400 |
| commit | e082cfb3b8f8226067078cc410e4997fd1cf14df (patch) | |
| tree | 4fe651510fa4179e875f82aebdc7405b3b752c7a /lib/btrfs/btrfsitem/items.go | |
| parent | 2ee7091933d2c07338dfb4699ce5665951b47afd (diff) | |
tree-wide: Ensure that all existing method doc comments follow the expected format
Diffstat (limited to 'lib/btrfs/btrfsitem/items.go')
| -rw-r--r-- | lib/btrfs/btrfsitem/items.go | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/btrfs/btrfsitem/items.go b/lib/btrfs/btrfsitem/items.go index dd14fb8..a730447 100644 --- a/lib/btrfs/btrfsitem/items.go +++ b/lib/btrfs/btrfsitem/items.go @@ -58,7 +58,11 @@ func (o *Error) UnmarshalBinary(dat []byte) (int, error) { return len(dat), nil } -// Rather than returning a separate error value, return an Error item. +// UnmarshalItem consumes the byte slice `dat`, unmarshaling it in to +// the item type specified by `key`. +// +// If there is an error, rather than returning a separate error value, +// return an Error item. func UnmarshalItem(key btrfsprim.Key, csumType btrfssum.CSumType, dat []byte) Item { var gotyp reflect.Type if key.ItemType == UNTYPED_KEY { |