changeset 40738:8947f49daaa8

revlog: update the docstring of `ancestors` to match reality Code using this method expect the revision to be (reverse) sorted. As pointed by Yuya Nishihara, the docstring should reflect that.
author Boris Feld <boris.feld@octobus.net>
date Mon, 26 Nov 2018 00:08:11 +0100
parents 32a23c3f56d4
children dc3ab5e5fe64
files mercurial/revlog.py
diffstat 1 files changed, 1 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/revlog.py	Mon Nov 26 15:53:34 2018 -0500
+++ b/mercurial/revlog.py	Mon Nov 26 00:08:11 2018 +0100
@@ -768,7 +768,7 @@
         return chain, stopped
 
     def ancestors(self, revs, stoprev=0, inclusive=False):
-        """Generate the ancestors of 'revs' in reverse topological order.
+        """Generate the ancestors of 'revs' in reverse revision order.
         Does not generate revs lower than stoprev.
 
         See the documentation for ancestor.lazyancestors for more details."""