aboutsummaryrefslogtreecommitdiff
path: root/repository/fetcher.go
diff options
context:
space:
mode:
Diffstat (limited to 'repository/fetcher.go')
-rw-r--r--repository/fetcher.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/repository/fetcher.go b/repository/fetcher.go
index 6701b806..7c3ea421 100644
--- a/repository/fetcher.go
+++ b/repository/fetcher.go
@@ -4,6 +4,10 @@ import "codeberg.org/lindenii/furgit/object/fetch"
// Fetcher returns an object fetcher backed by the repository's object store.
//
+// Use Fetcher when you want typed commits, trees, blobs, or tags, when you
+// need to peel through annotated tags, or when you want path-based access
+// within trees.
+//
// Labels: Life-Parent, Close-No.
func (repo *Repository) Fetcher() *fetch.Fetcher {
return fetch.New(repo.objects)