Boost C++ Libraries: Ticket #1607: Tuple Library Documentation Changes

Boost C++ Libraries: Ticket #1607: Tuple Library Documentation Changes https://svn.boost.org/trac10/ticket/1607 <p> In the <strong>Boost Tuple Users Guide</strong> <em>(/trunk/libs/tuple/doc/tuple_users_guide.html)</em>, I suggest the following changes. </p> <p> In the <em>The make_tuple function</em> section: </p> <pre class="wiki">(see the fifth code line below) </pre><p> should be </p> <pre class="wiki">(see the sixth code line below) </pre><p> In the <em>Accessing tuple elements</em> section: </p> <pre class="wiki">Violations of these constrains are... </pre><p> should be </p> <pre class="wiki">Violations of these constraints are... </pre><p> and </p> <pre class="wiki">...when writing code that shoud compile with MSVC++ 6.0. </pre><p> should be </p> <pre class="wiki">...when writing code that should compile with MSVC++ 6.0. </pre><p> In the <em>Performance</em> section: </p> <pre class="wiki">...using hand written tuple like classes. </pre><p> should be </p> <pre class="wiki">...using hand-written tuple-like classes. </pre><p> In the <em>Effect on Compile Time</em> section: </p> <pre class="wiki">Compile time increases between 5 to 10 percentages... </pre><p> should be </p> <pre class="wiki">Compile time increases between 5 and 10 percent... </pre><p> In the <em>Streaming</em> section: </p> <pre class="wiki">cin >> tuples::set_open('[') >> tuples::set_close(']') >> tules::set_delimiter(':'); </pre><p> should be </p> <pre class="wiki">cin >> tuples::set_open('[') >> tuples::set_close(']') >> tuples::set_delimiter(':'); </pre><p> [tules becomes tuples] </p> <p> <strong>HTML Markup</strong> After the line <em>Note particularly that the following is perfectly ok:</em> the text: </p> <pre class="wiki">Y y; tuple<char(&)[10], Y&>(a, y); </pre><p> is enclosed both in a <code><pre></pre></code> block and a <code><code></code></code> block. The <code><pre></pre></code> markup is illegal here and should be removed. </p> <p> The same error appears two more times. First in the HTML markup after <em>...the tuples subnamespace. For example:</em> and then again after <em>The code:</em> </p> <p> There are several instances where < or > characters are used and should be replaced with the character references &lt; and &gt;. An HTML validator will point them out. </p> <p> In <strong>Tuple library advanced features</strong> (<em>/trunk/libs/tuple/doc/tuple_advanced_interface.html</em>): </p> <pre class="wiki">...nonmeber and member get functions... </pre><p> should be </p> <pre class="wiki">...nonmember and member get functions... </pre><p> <strong>HTML Markup</strong> The <code><body bgcolor="#FFFFFF" text="#000000"></code> tag appears within the <code><head></head></code> section of the page and must be moved to a position after the <code></head></code> tag. The <code><body></code> tag is superfluous. </p> <p> Also, the tag <code><IMG SRC="../../../boost.png" ALT="C++ Boost" width="277" height="86"></code> must be moved to a position within the <code><body></body></code> section. </p> <p> After <em>The internal representation of the empty tuple...</em> the markup </p> <pre class="wiki">tuple&lt;&gt </pre><p> should be </p> <pre class="wiki">tuple&lt;&gt; </pre><p> [Adding a trailing semicolon.] </p> <p> There are five instances in which a <code><pre></pre></code> block is nested inside a <code><code></code></code> or a <code><code></code></code> block is nested inside a <code><pre></pre></code> block. The <code><pre></pre></code> blocks should be removed so that the computer code resides only within a <code><code></code></code> block. A pass of the page through an HTML validator will point out this and other problem areas. </p> <p> Six instances of erroneous <code><pre></pre></code> blocks also exist in the <strong>Tuple Library : design decisions rationale</strong> page (<em>/trunk/libs/tuple/doc/design_decisions_rationale.html</em>). </p> <p> Also on that design decisions rationale page in the parenthetical phrase after <em>Other orderings were considered, mainly dominance...</em> the HTML markup contains </p> <pre class="wiki"><b(i) </pre><p> which should be changed to </p> <pre class="wiki">&lt;b(i) </pre><p> The <code><!DOCTYPE></code> tag is missing on the page. </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/1607 Trac 1.4.3 Steven Watanabe Sat, 23 May 2009 19:00:36 GMT status changed; resolution set https://svn.boost.org/trac10/ticket/1607#comment:1 https://svn.boost.org/trac10/ticket/1607#comment:1 <ul> <li><strong>status</strong> <span class="trac-field-old">new</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> Fixed in <a class="changeset" href="https://svn.boost.org/trac10/changeset/53218" title="Fix typos/markup problems in tuple docs. Fixes #">[53218]</a>. </p> Ticket