diff options
| author | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-23 17:07:08 +0100 |
|---|---|---|
| committer | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-23 17:14:43 +0100 |
| commit | 059a0be78399cdb0648bd514c5b179819d84403d (patch) | |
| tree | 007fea2e8529b865b354b45c8aed9045e136d462 /plumbing/storer/reference.go | |
| parent | b5da4e98571b02dc106de4f9b2cb2a298489f1b1 (diff) | |
| download | go-git-059a0be78399cdb0648bd514c5b179819d84403d.tar.gz | |
plumbing: improve documentation (Fix #242)
Diffstat (limited to 'plumbing/storer/reference.go')
| -rw-r--r-- | plumbing/storer/reference.go | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/plumbing/storer/reference.go b/plumbing/storer/reference.go index 692fe88..b408778 100644 --- a/plumbing/storer/reference.go +++ b/plumbing/storer/reference.go @@ -13,7 +13,7 @@ const MaxResolveRecursion = 1024 // is exceeded var ErrMaxResolveRecursion = errors.New("max. recursion level reached") -// ReferenceStorer generic storage of references +// ReferenceStorer is a generic storage of references. type ReferenceStorer interface { SetReference(*plumbing.Reference) error Reference(plumbing.ReferenceName) (*plumbing.Reference, error) @@ -21,7 +21,7 @@ type ReferenceStorer interface { RemoveReference(plumbing.ReferenceName) error } -// ReferenceIter is a generic closable interface for iterating over references +// ReferenceIter is a generic closable interface for iterating over references. type ReferenceIter interface { Next() (*plumbing.Reference, error) ForEach(func(*plumbing.Reference) error) error @@ -82,7 +82,7 @@ func (iter *ReferenceSliceIter) Close() { iter.pos = len(iter.series) } -// ResolveReference resolve a SymbolicReference to a HashReference +// ResolveReference resolves a SymbolicReference to a HashReference. func ResolveReference(s ReferenceStorer, n plumbing.ReferenceName) (*plumbing.Reference, error) { r, err := s.Reference(n) if err != nil || r == nil { |