diff options
author | Antonio Jesus Navarro Perez <antnavper@gmail.com> | 2018-07-30 10:38:28 +0200 |
---|---|---|
committer | Antonio Jesus Navarro Perez <antnavper@gmail.com> | 2018-07-30 10:41:24 +0200 |
commit | 3d2bcdabdeda200d04eeaa3aeca7cc653317a961 (patch) | |
tree | 99b9a892326c1b523b4a2ab71c30cf2af73d9f77 | |
parent | 9f00789688d26191a987fdec8bc2678362ec4453 (diff) | |
download | go-git-3d2bcdabdeda200d04eeaa3aeca7cc653317a961.tar.gz |
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 <antnavper@gmail.com>
-rw-r--r-- | repository.go | 5 |
1 files changed, 3 insertions, 2 deletions
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 { |