diff options
| author | Máximo Cuadros <mcuadros@gmail.com> | 2017-02-27 12:59:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-02-27 12:59:51 +0100 |
| commit | a8f1e517e302569f11fced521c3f091997dac147 (patch) | |
| tree | 16bbe6118340bfedf35080e66e44a76840fb3afb /plumbing/storer/reference.go | |
| parent | 39f43b52a2bdfbc73703e2d09b575d49cd70ede8 (diff) | |
| parent | 059a0be78399cdb0648bd514c5b179819d84403d (diff) | |
| download | go-git-a8f1e517e302569f11fced521c3f091997dac147.tar.gz | |
Merge pull request #288 from ajnavarro/documentation/plumbing
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 6c2de0d..d821ecf 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 { |