From fc2eddf2f0166d491c28481acae529b2ab55f87c Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Mon, 23 Mar 2026 06:17:52 +0000
Subject: object/resolve: Add docs to treefs exported functions

---
 object/resolve/treefs_open.go | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'object/resolve/treefs_open.go')

diff --git a/object/resolve/treefs_open.go b/object/resolve/treefs_open.go
index 76bd5e4f..9d97f58e 100644
--- a/object/resolve/treefs_open.go
+++ b/object/resolve/treefs_open.go
@@ -8,6 +8,10 @@ import (
 	"codeberg.org/lindenii/furgit/object"
 )
 
+// Open opens name for reading.
+//
+// Directories are returned as fs.ReadDirFile values. Gitlink entries are not
+// readable through TreeFS.
 func (treeFS *TreeFS) Open(name string) (fs.File, error) {
 	entry, err := treeFS.resolvePath(treeFSOpOpen, name)
 	if err != nil {
-- 
cgit v1.3.1-10-gc9f91