From 655b6b211ae6df0186abd740f248939f7ddeaec1 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Mon, 31 Mar 2025 16:59:18 +0800
Subject: Add descriptive comments to most Go functions

---
 cache_commit_tree_readme.go | 1 +
 1 file changed, 1 insertion(+)

(limited to 'cache_commit_tree_readme.go')

diff --git a/cache_commit_tree_readme.go b/cache_commit_tree_readme.go
index de58d71..afd7f3e 100644
--- a/cache_commit_tree_readme.go
+++ b/cache_commit_tree_readme.go
@@ -16,6 +16,7 @@ type treeReadmeCacheEntry struct {
 	ReadmeRendered template.HTML
 }
 
+// The key is the commit ID raw hash, optionally followed by a path.
 var treeReadmeCache *ristretto.Cache[[]byte, treeReadmeCacheEntry]
 
 func init() {
-- 
cgit v1.2.3