[Python-checkins] [python/cpython] b4e1b9: Docs: Add note regarding "reversed" flag in heapq....

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/python/cpython
  Commit: b4e1b92aabcd302ac54fa58cd4fee8a138dbb5aa
      https://github.com/python/cpython/commit/b4e1b92aabcd302ac54fa58cd4fee8a138dbb5aa
  Author: Adam Niederer <AdamNiederer at users.noreply.github.com>
  Date:   2017-03-05 (Sun, 05 Mar 2017)

  Changed paths:
    M Doc/library/heapq.rst

  Log Message:
  -----------
  Docs: Add note regarding "reversed" flag in heapq.merge (#300)

The docs for `heapq.merge` are a little misleading. Iterables passed
into heapq.merge with the reversed flag enabled must be sorted from
largest to smallest to achieve the desired sorting effect, but the
previous paragraph states that they should be sorted from smallest
to largest.