From patchwork Tue Dec 24 00:32:19 2013
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: [2,of,5] obsolete: improve allsuccessors doc string
From: Pierre-Yves David <pierre-yves.david@ens-lyon.org>
X-Patchwork-Id: 3231
Message-Id: <df0ed06fa7692e4091c0.1387845139@marginatus.fb.com>
To: mercurial-devel@selenic.com
Cc: pierre-yves.david@ens-lyon.org
Date: Mon, 23 Dec 2013 16:32:19 -0800

# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@ens-lyon.org>
# Date 1387834401 28800
#      Mon Dec 23 13:33:21 2013 -0800
# Node ID df0ed06fa7692e4091c017fb3ed746d8e1c25b8d
# Parent  3364efb44fbd4ef52c02e6725f5958c6f2130531
obsolete: improve allsuccessors doc string

The fact original nodes are also yield is not obvious. We update the docstring
to highlight it.

diff --git a/mercurial/obsolete.py b/mercurial/obsolete.py
--- a/mercurial/obsolete.py
+++ b/mercurial/obsolete.py
@@ -438,11 +438,12 @@ def successormarkers(ctx):
 def allsuccessors(obsstore, nodes, ignoreflags=0):
     """Yield node for every successor of <nodes>.
 
     Some successors may be unknown locally.
 
-    This is a linear yield unsuited to detecting split changesets."""
+    This is a linear yield unsuited to detecting split changesets. It includes
+    initial nodes too."""
     remaining = set(nodes)
     seen = set(remaining)
     while remaining:
         current = remaining.pop()
         yield current