]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Fixup docstrings for merge().
authorRaymond Hettinger <python@rcn.com>
Mon, 19 Feb 2007 18:15:04 +0000 (18:15 +0000)
committerRaymond Hettinger <python@rcn.com>
Mon, 19 Feb 2007 18:15:04 +0000 (18:15 +0000)
Doc/lib/libheapq.tex
Lib/heapq.py

index 32cc25e77a56048341162729eb7322a215fa0606..e403a3a10deb317ff11b786e623d6fed26fda1ff 100644 (file)
@@ -96,8 +96,8 @@ timestamped entries from multiple log files).  Returns an iterator over
 over the sorted values.
 
 Similar to \code{sorted(itertools.chain(*iterables))} but returns an iterable,
-does not pull the data into memory all at once, and reduces the number of
-comparisons by assuming that each of the input streams is already sorted.            
+does not pull the data into memory all at once, and assumes that each of the
+input streams is already sorted (smallest to largest).            
 \versionadded{2.6}
 \end{funcdesc}
 
index 5d4142581afbd9386b182bdf8127de7e3d61c179..0f67236929aeafaf69960c9082e1de872138d355 100644 (file)
@@ -312,8 +312,8 @@ def merge(*iterables):
     '''Merge multiple sorted inputs into a single sorted output.
 
     Similar to sorted(itertools.chain(*iterables)) but returns an iterable,
-    does not pull the data into memory all at once, and reduces the number
-    of comparisons by assuming that each of the input streams is already sorted.
+    does not pull the data into memory all at once, and assumes that each of
+    the input streams is already sorted (smallest to largest).
 
     >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25]))
     [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]