Fix documentation of git_branch_delete.

The reference should be freed by the user, not the library.

Fix documentation of git_branch_delete.
The reference should be freed by the user, not the library.
f8bd730c · Daniel Rodríguez Troitiño · 0d77647a · f8bd730c
Commit f8bd730c authored May 26, 2013 by Daniel Rodríguez Troitiño
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 1 deletions

include/git2/branch.h
+2 -1

No files found.
--- a/include/git2/branch.h
+++ b/include/git2/branch.h
@@ -58,7 +58,8 @@ GIT_EXTERN(int) git_branch_create(
 * Delete an existing branch reference.
 *
 * If the branch is successfully deleted, the passed reference
- * object will be freed and invalidated.
+ * object will be invalidated. The reference must be freed manually
+ * by the user.
 *
 * @param branch A valid reference representing a branch
 * @return 0 on success, or an error code.