From 3d2bcdabdeda200d04eeaa3aeca7cc653317a961 Mon Sep 17 00:00:00 2001 From: Antonio Jesus Navarro Perez Date: Mon, 30 Jul 2018 10:38:28 +0200 Subject: Fix wrong godoc on Tags() method. Reword Tags() method documentation. Point to TagObjects() method to get all the tags on a repository. Signed-off-by: Antonio Jesus Navarro Perez --- repository.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'repository.go') diff --git a/repository.go b/repository.go index 680522c..54572bc 100644 --- a/repository.go +++ b/repository.go @@ -845,8 +845,9 @@ func (r *Repository) Log(o *LogOptions) (object.CommitIter, error) { return nil, fmt.Errorf("invalid Order=%v", o.Order) } -// Tags returns all the References from Tags. This method returns all the tag -// types, lightweight, and annotated ones. +// Tags returns all the References from Tags. This method returns only lightweight +// tags. Note that not all the tags are lightweight ones. To return annotated tags +// too, you need to call TagObjects() method. func (r *Repository) Tags() (storer.ReferenceIter, error) { refIter, err := r.Storer.IterReferences() if err != nil { -- cgit