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_readfile.go | 3 +++
 1 file changed, 3 insertions(+)

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

diff --git a/object/resolve/treefs_readfile.go b/object/resolve/treefs_readfile.go
index 72af931c..e2bc1698 100644
--- a/object/resolve/treefs_readfile.go
+++ b/object/resolve/treefs_readfile.go
@@ -7,6 +7,9 @@ import (
 	"codeberg.org/lindenii/furgit/object"
 )
 
+// ReadFile reads the blob contents at name.
+//
+// Directories and gitlink entries are not readable through TreeFS.
 func (treeFS *TreeFS) ReadFile(name string) ([]byte, error) {
 	entry, err := treeFS.resolvePath(treeFSOpReadFile, name)
 	if err != nil {
-- 
cgit v1.3.1-10-gc9f91