[issue29722] heapq.merge docs don't handle reverse flag well

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@python components: Documentation messages: 288997 nosy: adamniederer, docs@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@bugs.python.org> <http://bugs.python.org/issue29722> _______________________________________

Changes by Adam <adam.niederer@gmail.com>: ---------- title: heapq.merge docs don't handle reverse flag well -> heapq.merge docs are misleading with the "reversed" flag _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29722> _______________________________________

Changes by Raymond Hettinger <raymond.hettinger@gmail.com>: ---------- assignee: docs@python -> rhettinger nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29722> _______________________________________

Changes by Terry J. Reedy <tjreedy@udel.edu>: ---------- versions: -Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29722> _______________________________________

Raymond Hettinger added the comment: The PR was applied to 3.7. I don't think it is worth backing. ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29722> _______________________________________
participants (3)
-
Adam
-
Raymond Hettinger
-
Terry J. Reedy