path: update `get_unique_pull_path` to point out it returns a url
authorPierre-Yves David <pierre-yves.david@octobus.net>
Thu, 01 Dec 2022 16:53:22 +0100
changeset 49715 ce5f49e8d6ed
parent 49714 f04d459909c6
child 49716 d4926e08507d
path: update `get_unique_pull_path` to point out it returns a url Unlike other functions in this module it returns a url as `bytes` and not a `path` object. Let us point it out in the doc.
mercurial/utils/urlutil.py
--- a/mercurial/utils/urlutil.py	Fri Dec 02 02:03:49 2022 +0100
+++ b/mercurial/utils/urlutil.py	Thu Dec 01 16:53:22 2022 +0100
@@ -545,7 +545,7 @@
 
 
 def get_unique_pull_path(action, repo, ui, source=None, default_branches=()):
-    """return a unique `(path, branch)` or abort if multiple are found
+    """return a unique `(url, branch)` or abort if multiple are found
 
     This is useful for command and action that does not support multiple
     destination (yet).