changeset 37677:41ac707322ba

scmutil: document that isrevsymbol() raises on ambiguous node prefix Differential Revision: https://phab.mercurial-scm.org/D3308
author Martin von Zweigbergk <martinvonz@google.com>
date Fri, 13 Apr 2018 09:48:22 -0700
parents 1764527af92e
children 5f8f013e7d52
files mercurial/scmutil.py
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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