docs: correct docstring info for git_remote_url

Signed-off-by: Dominique Fuchs <[email protected]>

diff --git a/include/git2/remote.h b/include/git2/remote.h
index ecb7b53..2472ded 100644 (file)
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -249,9 +249,9 @@ GIT_EXTERN(const char *) git_remote_name(const git_remote *remote);
 /**
  * Get the remote's url
  *
- * If url.*.insteadOf has been configured for this URL, it will
- * return the modified URL.  If `git_remote_set_instance_pushurl`
- * has been called for this remote, then that URL will be returned.
+ * If url.*.insteadOf has been configured for this URL, it will return
+ * the modified URL. This function does not consider if a push url has
+ * been configured for this remote (use `git_remote_pushurl` if needed).
  *
  * @param remote the remote
  * @return a pointer to the url