Patchwork [1,of,5,FOLLOW-UP] revlog: update the docstring of `ancestors` to match reality

login
register
mail settings
Submitter Boris Feld
Date Nov. 26, 2018, 6:33 p.m.
Message ID <87443a7ac7f6a37ed59d.1543257230@localhost.localdomain>
Download mbox | patch
Permalink /patch/36786/
State Accepted
Headers show

Comments

Boris Feld - Nov. 26, 2018, 6:33 p.m.
# HG changeset patch
# User Boris Feld <boris.feld@octobus.net>
# Date 1543187291 -3600
#      Mon Nov 26 00:08:11 2018 +0100
# Node ID 87443a7ac7f6a37ed59d6429c87118c64b7287f6
# Parent  cfaf3843491bde30916b89180d5f67561a22da28
# EXP-Topic follow-up-yuya
# Available At https://bitbucket.org/octobus/mercurial-devel/
#              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r 87443a7ac7f6
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.
Yuya Nishihara - Nov. 27, 2018, 11:32 a.m.
On Mon, 26 Nov 2018 19:33:50 +0100, Boris Feld wrote:
> # HG changeset patch
> # User Boris Feld <boris.feld@octobus.net>
> # Date 1543187291 -3600
> #      Mon Nov 26 00:08:11 2018 +0100
> # Node ID 87443a7ac7f6a37ed59d6429c87118c64b7287f6
> # Parent  cfaf3843491bde30916b89180d5f67561a22da28
> # EXP-Topic follow-up-yuya
> # Available At https://bitbucket.org/octobus/mercurial-devel/
> #              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r 87443a7ac7f6
> revlog: update the docstring of `ancestors` to match reality

Queued the series, many thanks.

Patch

diff --git a/mercurial/revlog.py b/mercurial/revlog.py
--- a/mercurial/revlog.py
+++ b/mercurial/revlog.py
@@ -768,7 +768,7 @@  class revlog(object):
         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."""