From 161d2fab0b7ddee35696c5600d3ebd5bae6e6527 Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Sun, 29 Mar 2026 08:09:34 +0000
Subject: repository: Add guidance

---
 repository/open.go | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'repository/open.go')

diff --git a/repository/open.go b/repository/open.go
index 3c400f60..3724df26 100644
--- a/repository/open.go
+++ b/repository/open.go
@@ -8,7 +8,11 @@ import (
 	reffiles "codeberg.org/lindenii/furgit/ref/store/files"
 )
 
-// Open opens a repository and wires object/ref stores from its on-disk format.
+// Open opens a repository and wires its stores and helpers from the on-disk
+// repository format.
+//
+// root must refer to the Git directory itself:
+// a bare repository root or a non-bare ".git" directory.
 //
 // Labels: Deps-Borrowed.
 func Open(root *os.Root) (repo *Repository, err error) {
-- 
cgit v1.3.1-10-gc9f91