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/btrfsprim/key.go | |
| parent | 2ee7091933d2c07338dfb4699ce5665951b47afd (diff) | |
tree-wide: Ensure that all existing method doc comments follow the expected format
Diffstat (limited to 'lib/btrfs/btrfsprim/key.go')
| -rw-r--r-- | lib/btrfs/btrfsprim/key.go | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/btrfs/btrfsprim/key.go b/lib/btrfs/btrfsprim/key.go index b07cc8c..2930782 100644 --- a/lib/btrfs/btrfsprim/key.go +++ b/lib/btrfs/btrfsprim/key.go @@ -21,7 +21,10 @@ type Key struct { const MaxOffset uint64 = math.MaxUint64 -// mimics print-tree.c:btrfs_print_key() +// Format returns a human-friendly string representation of the Key, +// according to which tree it appears in. +// +// The formatting of the key mimics print-tree.c:btrfs_print_key(). func (key Key) Format(tree ObjID) string { switch tree { case UUID_TREE_OBJECTID: |