[New-bugs-announce] [issue29722] heapq.merge docs don't handle reverse flag well

[Adam]

New submission from Adam:

The docs for heapq.merge are a little misleading. Iterables passed into heapq.merge with the reversed flag set to True must be sorted from largest to smallest to achieve the desired sorting effect, but the paragraph describing the function in the general case states that they should be sorted from smallest to largest.

----------
assignee: docs at python
components: Documentation
messages: 288997
nosy: adamniederer, docs at python
priority: normal
pull_requests: 388
severity: normal
status: open
title: heapq.merge docs don't handle reverse flag well
type: behavior
versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue29722>
_______________________________________