[Boost-bugs] [Boost C++ Libraries] #10663: Cut-and-paste error in fibonacci heap ordered_end documentation

Subject: [Boost-bugs] [Boost C++ Libraries] #10663: Cut-and-paste error in fibonacci heap ordered_end documentation
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2014-10-15 22:04:24

#10663: Cut-and-paste error in fibonacci heap ordered_end documentation
------------------------------+--------------------------
 Reporter:  mbradle@…         |      Owner:  timblechmann
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  heap
  Version:  Boost 1.56.0      |   Severity:  Cosmetic
 Keywords:                    |
------------------------------+--------------------------
 The fibonacci_heap documentation has an error for the ordered_iterator
 ordered_end(void) const; function.  It seems to be a cut-and-paste error.
 The fix:

 {{{
 diff --git a/include/boost/heap/fibonacci_heap.hpp
 b/include/boost/heap/fibonacci_heap.hpp
 index 493828f..89b05d8 100644
 --- a/include/boost/heap/fibonacci_heap.hpp
 +++ b/include/boost/heap/fibonacci_heap.hpp
 @@ -573,7 +573,7 @@ public:
      }

      /**
 -     * \b Effects: Returns an ordered iterator to the first element
 contained in the priority queue.
 +     * \b Effects: Returns an ordered iterator to the end of the priority
 queue.
       *
       * \b Note: Ordered iterators traverse the priority queue in heap
 order.
       * */
 }}}

 Best wishes.

 Brad Meyer

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/10663>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.