From a4bbec5a9b01c48dcbfd13519e6bae7fcffec449 Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Sat, 28 Mar 2026 13:07:55 +0000
Subject: repository: Unify docs

---
 repository/objects.go | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'repository/objects.go')

diff --git a/repository/objects.go b/repository/objects.go
index 0aba751a..ec83f70b 100644
--- a/repository/objects.go
+++ b/repository/objects.go
@@ -12,6 +12,15 @@ import (
 	objectpacked "codeberg.org/lindenii/furgit/object/store/packed"
 )
 
+// openObjectStore opens the roots and object stores of both
+// the loose and packed stores for a particular repo root and
+// object ID hashing algorithm.
+//
+// Since real object store implementations do not take ownership of
+// the roots given to them, and since composite object stores do not
+// take ownership of the object stores that they consist of, all
+// of them are returned and should be closed by the caller.
+//
 //nolint:ireturn
 func openObjectStore(
 	root *os.Root,
-- 
cgit v1.3.1-10-gc9f91