push: reword comment on finish()

carlosmn · carlosmn · commit 85a6d5f49ca3 · 2014-12-10T18:55:54.000+01:00
This should make it clearer what the return value implies.
diff --git a/include/git2/push.h b/include/git2/push.h
@@ -128,12 +128,14 @@ GIT_EXTERN(int) git_push_update_tips(
 		const char *reflog_message);
 
 /**
- * Actually push all given refspecs
+ * Perform the push
  *
- * Note: To check if the push was successful (i.e. all remote references
- * have been updated as requested), you need to call
- * `git_push_status_foreach`. The remote
- * repository might have refused to update some or all of the references.
+ * This function will return an error in case of a protocol error or
+ * the server being unable to unpack the data we sent.
+ *
+ * The return value does not reflect whether the server accepted or
+ * refused any reference updates. Use `git_push_status_foreach()` in
+ * order to find out which updates were accepted or rejected.
  *
  * @param push The push object
  *

Original file line number	Diff line number	Diff line change
`@@ -128,12 +128,14 @@ GIT_EXTERN(int) git_push_update_tips(`
`128`	`128`	`const char *reflog_message);`
`129`	`129`
`130`	`130`	`/**`
`131`		`- * Actually push all given refspecs`
	`131`	`+ * Perform the push`
`132`	`132`	`*`
`133`		`- * Note: To check if the push was successful (i.e. all remote references`
`134`		`- * have been updated as requested), you need to call`
`135`		- * `git_push_status_foreach`. The remote
`136`		`- * repository might have refused to update some or all of the references.`
	`133`	`+ * This function will return an error in case of a protocol error or`
	`134`	`+ * the server being unable to unpack the data we sent.`
	`135`	`+ *`
	`136`	`+ * The return value does not reflect whether the server accepted or`
	`137`	+ * refused any reference updates. Use `git_push_status_foreach()` in
	`138`	`+ * order to find out which updates were accepted or rejected.`
`137`	`139`	`*`
`138`	`140`	`* @param push The push object`
`139`	`141`	`*`