From 00e1550a238b77e668d1f9934b9d09913a82381f Mon Sep 17 00:00:00 2001
From: Dominique Fuchs <32204802+DominiqueFuchs@users.noreply.github.com>
Date: Fri, 16 May 2025 15:00:53 +0200
Subject: [PATCH] docs: correct docstring info for git_remote_url

Signed-off-by: Dominique Fuchs <32204802+DominiqueFuchs@users.noreply.github.com>
---
 include/git2/remote.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/git2/remote.h b/include/git2/remote.h
index ecb7b537e..2472dedcc 100644
--- 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