aboutsummaryrefslogtreecommitdiffstats
path: root/plumbing/object/commitnode.go
diff options
context:
space:
mode:
Diffstat (limited to 'plumbing/object/commitnode.go')
-rw-r--r--plumbing/object/commitnode.go5
1 files changed, 2 insertions, 3 deletions
diff --git a/plumbing/object/commitnode.go b/plumbing/object/commitnode.go
index 62c0aef..22927f4 100644
--- a/plumbing/object/commitnode.go
+++ b/plumbing/object/commitnode.go
@@ -8,8 +8,8 @@ import (
"gopkg.in/src-d/go-git.v4/plumbing/storer"
)
-// CommitNode is generic interface encapsulating either Commit object or
-// graphCommitNode object
+// CommitNode is generic interface encapsulating a lightweight commit object retrieved
+// from CommitNodeIndex
type CommitNode interface {
// ID returns the Commit object id referenced by the commit graph node.
ID() plumbing.Hash
@@ -30,7 +30,6 @@ type CommitNode interface {
}
// CommitNodeIndex is generic interface encapsulating an index of CommitNode objects
-// and accessor methods for walking it as a directed graph
type CommitNodeIndex interface {
// Get returns a commit node from a commit hash
Get(hash plumbing.Hash) (CommitNode, error)