summaryrefslogtreecommitdiff
path: root/include/git2/refs.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/refs.h')
-rw-r--r--include/git2/refs.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h
index fa9958369..468d0f930 100644
--- a/include/git2/refs.h
+++ b/include/git2/refs.h
@@ -48,7 +48,7 @@ GIT_EXTERN(int) git_reference_lookup(git_reference **out, git_repository *repo,
*
* @param out Pointer to oid to be filled in
* @param repo The repository in which to look up the reference
- * @param name The long name for the reference
+ * @param name The long name for the reference (e.g. HEAD, refs/heads/master, refs/tags/v0.1.0, ...)
* @return 0 on success, ENOTFOUND, EINVALIDSPEC or an error code.
*/
GIT_EXTERN(int) git_reference_name_to_id(