aboutsummaryrefslogtreecommitdiff
path: root/repository/reachability.go
diff options
context:
space:
mode:
Diffstat (limited to 'repository/reachability.go')
-rw-r--r--repository/reachability.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/repository/reachability.go b/repository/reachability.go
index 4e6a4559..24f9e2bd 100644
--- a/repository/reachability.go
+++ b/repository/reachability.go
@@ -5,6 +5,9 @@ import "codeberg.org/lindenii/furgit/reachability"
// Reachability returns graph traversal helpers backed by the repository's
// object store and optional commit-graph.
//
+// Use Reachability to walk reachable commits or objects and to perform
+// connectivity checks.
+//
// Labels: Life-Parent, Close-No.
func (repo *Repository) Reachability() *reachability.Reachability {
return reachability.New(repo.objects, repo.commitGraph)