Commit 56ac6c0a4b7c4be60642fcda702b9b68c3eb8a75

Jacob Wahlgren 2017-09-30T17:23:11

graph: document that a commit isn't a descendant of itself

1
2
3
4
5
6
7
8
9
10
11
12
13
14
diff --git a/include/git2/graph.h b/include/git2/graph.h
index c997d8c..213ae97 100644
--- a/include/git2/graph.h
+++ b/include/git2/graph.h
@@ -40,6 +40,9 @@ GIT_EXTERN(int) git_graph_ahead_behind(size_t *ahead, size_t *behind, git_reposi
 /**
  * Determine if a commit is the descendant of another commit.
  *
+ * Note that a commit is not considered a descendant of itself, in contrast
+ * to `git merge-base --is-ancestor`.
+ *
  * @param commit a previously loaded commit.
  * @param ancestor a potential ancestor commit.
  * @return 1 if the given commit is a descendant of the potential ancestor,