docs: correct docstring info for git_remote_url

DominiqueFuchs · DominiqueFuchs · commit 00e1550a238b · 2025-05-16T15:00:53.000+02:00
Signed-off-by: Dominique Fuchs &lt;32204802+DominiqueFuchs@users.noreply.github.com&gt;
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -249,9 +249,9 @@ GIT_EXTERN(const char ) git_remote_name(const git_remote remote);`
`249`	`249`	`/**`
`250`	`250`	`* Get the remote's url`
`251`	`251`	`*`
`252`		`- * If url.*.insteadOf has been configured for this URL, it will`
`253`		- * return the modified URL. If `git_remote_set_instance_pushurl`
`254`		`- * has been called for this remote, then that URL will be returned.`
	`252`	`+ * If url.*.insteadOf has been configured for this URL, it will return`
	`253`	`+ * the modified URL. This function does not consider if a push url has`
	`254`	+ * been configured for this remote (use `git_remote_pushurl` if needed).
`255`	`255`	`*`
`256`	`256`	`* @param remote the remote`
`257`	`257`	`* @return a pointer to the url`