diff options
Diffstat (limited to 'repository/refs.go')
| -rw-r--r-- | repository/refs.go | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/repository/refs.go b/repository/refs.go index 2e89aed6..0403e001 100644 --- a/repository/refs.go +++ b/repository/refs.go @@ -4,6 +4,10 @@ import refstore "codeberg.org/lindenii/furgit/ref/store" // Refs returns the configured ref store. // +// Use Refs when starting from branch names, tags, HEAD, or other references. +// A common pattern is to resolve a reference first and then pass the resulting +// object ID to [Repository.Fetcher] or [Repository.Objects]. +// // Labels: Life-Parent, Close-No. // //nolint:ireturn |