aboutsummaryrefslogtreecommitdiffstats
path: root/cache/bug_cache.go
diff options
context:
space:
mode:
Diffstat (limited to 'cache/bug_cache.go')
-rw-r--r--cache/bug_cache.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/cache/bug_cache.go b/cache/bug_cache.go
index 25ff000c..53c5c7d9 100644
--- a/cache/bug_cache.go
+++ b/cache/bug_cache.go
@@ -11,6 +11,10 @@ import (
"github.com/MichaelMure/git-bug/util/git"
)
+// BugCache is a wrapper around a Bug. It provide multiple functions:
+//
+// 1. Provide a higher level API to use than the raw API from Bug.
+// 2. Maintain an up to date Snapshot available.
type BugCache struct {
repoCache *RepoCache
bug *bug.WithSnapshot