From e082cfb3b8f8226067078cc410e4997fd1cf14df Mon Sep 17 00:00:00 2001
From: Luke Shumaker <lukeshu@lukeshu.com>
Date: Thu, 16 Mar 2023 18:45:45 -0400
Subject: tree-wide: Ensure that all existing method doc comments follow the
 expected format

---
 lib/btrfs/btrfsprim/key.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'lib/btrfs/btrfsprim/key.go')

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:
-- 
cgit v1.2.3-54-g00ecf