scmutil: document that isrevsymbol() raises on ambiguous node prefix
authorMartin von Zweigbergk <martinvonz@google.com>
Fri, 13 Apr 2018 09:48:22 -0700
changeset 37677 41ac707322ba
parent 37676 1764527af92e
child 37678 5f8f013e7d52
scmutil: document that isrevsymbol() raises on ambiguous node prefix Differential Revision: https://phab.mercurial-scm.org/D3308
mercurial/scmutil.py
--- a/mercurial/scmutil.py	Fri Apr 13 09:19:38 2018 -0700
+++ b/mercurial/scmutil.py	Fri Apr 13 09:48:22 2018 -0700
@@ -444,6 +444,11 @@
     return node
 
 def isrevsymbol(repo, symbol):
+    """Checks if a symbol exists in the repo.
+
+    See revsymbol() for details. Raises error.LookupError if the symbol is an
+    ambiguous nodeid prefix.
+    """
     try:
         revsymbol(repo, symbol)
         return True