Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r82313 - in trunk/libs/range/doc: html html/range/reference/algorithms/heap reference/algorithm
From: zeratul976_at_[hidden]
Date: 2013-01-02 00:27:06


Author: nathanridge
Date: 2013-01-02 00:27:02 EST (Wed, 02 Jan 2013)
New Revision: 82313
URL: http://svn.boost.org/trac/boost/changeset/82313

Log:
[range] fixed #5775 (typo in the documentation of pop_heap())
Text files modified:
   trunk/libs/range/doc/html/index.html | 2 +-
   trunk/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html | 4 ++--
   trunk/libs/range/doc/reference/algorithm/pop_heap.qbk | 2 +-
   3 files changed, 4 insertions(+), 4 deletions(-)

Modified: trunk/libs/range/doc/html/index.html
==============================================================================
--- trunk/libs/range/doc/html/index.html (original)
+++ trunk/libs/range/doc/html/index.html 2013-01-02 00:27:02 EST (Wed, 02 Jan 2013)
@@ -147,7 +147,7 @@
   </p>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: December 13, 2012 at 06:53:49 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 02, 2013 at 05:22:10 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: trunk/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html
==============================================================================
--- trunk/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html (original)
+++ trunk/libs/range/doc/html/range/reference/algorithms/heap/pop_heap.html 2013-01-02 00:27:02 EST (Wed, 02 Jan 2013)
@@ -52,8 +52,8 @@
           </h6>
 <p>
             <code class="computeroutput"><span class="identifier">pop_heap</span></code> removes the
- largest element from the heap. It is assumed that <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is already a heap and that the element
- to be added is <code class="computeroutput"><span class="special">*</span><span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>.
+ largest element from the heap. It is assumed that <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is already a heap (and therefore the
+ largest element is <code class="computeroutput"><span class="special">*</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>).
           </p>
 <p>
             The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code> in the non-predicate versions, and

Modified: trunk/libs/range/doc/reference/algorithm/pop_heap.qbk
==============================================================================
--- trunk/libs/range/doc/reference/algorithm/pop_heap.qbk (original)
+++ trunk/libs/range/doc/reference/algorithm/pop_heap.qbk 2013-01-02 00:27:02 EST (Wed, 02 Jan 2013)
@@ -23,7 +23,7 @@
 
 [heading Description]
 
-`pop_heap` removes the largest element from the heap. It is assumed that `begin(rng), prior(end(rng))` is already a heap and that the element to be added is `*prior(end(rng))`.
+`pop_heap` removes the largest element from the heap. It is assumed that `begin(rng), prior(end(rng))` is already a heap (and therefore the largest element is `*begin(rng)`).
 
 The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions.
 


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk