revset: improve documentation on expectsize()
authorNavaneeth Suresh <navaneeths1998@gmail.com>
Wed, 13 Feb 2019 18:17:42 +0530
changeset 41698 5fe4de392edb
parent 41697 e21183db2259
child 41699 5d63cb7d8f83
revset: improve documentation on expectsize() This is a follow-up patch to D5813. It improves the documentation of `expectsize(set, size)`. Differential Revision: https://phab.mercurial-scm.org/D5953
mercurial/revset.py
--- a/mercurial/revset.py	Wed Feb 13 12:09:36 2019 -0800
+++ b/mercurial/revset.py	Wed Feb 13 18:17:42 2019 +0530
@@ -863,7 +863,13 @@
 
 @predicate('expectsize(set[, size])', safe=True, takeorder=True)
 def expectsize(repo, subset, x, order):
-    """Abort if the revset doesn't expect given size"""
+    """Return the given revset if size matches the revset size.
+    Abort if the revset doesn't expect given size.
+    size can either be an integer range or an integer.
+
+    For example, ``expectsize(0:1, 3:5)`` will abort as revset size is 2 and
+    2 is not between 3 and 5 inclusive."""
+
     args = getargsdict(x, 'expectsize', 'set size')
     minsize = 0
     maxsize = len(repo) + 1