aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMorgan <git@howl.moe>2018-06-13 10:19:36 +0200
committerMorgan Bazalgette <the@howl.moe>2018-06-16 12:49:57 +0200
commit960fe7b668c7a0ebbd75f8898c95d5c4bdedf1f3 (patch)
tree4c42b481b08fcef99346ea1cb4ff3ecf05a2d847
parent0710c6cb710a0cdab04ab7f61cc62e23cfcacbee (diff)
downloadgo-git-960fe7b668c7a0ebbd75f8898c95d5c4bdedf1f3.tar.gz
Fix documentation for Notes
It previously said that it returned all references that are branches, but that's not true. Signed-off-by: Morgan Bazalgette <the@howl.moe>
-rw-r--r--repository.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/repository.go b/repository.go
index 717381b..680522c 100644
--- a/repository.go
+++ b/repository.go
@@ -872,7 +872,8 @@ func (r *Repository) Branches() (storer.ReferenceIter, error) {
}, refIter), nil
}
-// Notes returns all the References that are Branches.
+// Notes returns all the References that are notes. For more information:
+// https://git-scm.com/docs/git-notes
func (r *Repository) Notes() (storer.ReferenceIter, error) {
refIter, err := r.Storer.IterReferences()
if err != nil {