docs: correct docstring info for git_remote_url

Signed-off-by: Dominique Fuchs <32204802+DominiqueFuchs@users.noreply.github.com>
This commit is contained in:
Dominique Fuchs
2025-05-16 15:00:53 +02:00
parent 21a351b0ed
commit 00e1550a23

View File

@@ -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