Subject: [Boost-bugs] [Boost C++ Libraries] #1607: Tuple Library Documentation Changes
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-01-26 21:59:38
#1607: Tuple Library Documentation Changes
-------------------------------------------------------+--------------------
Reporter: Charles Brockman <cmbrockman_at_[hidden]> | Owner: djowel
Type: Bugs | Status: new
Milestone: Boost 1.36.0 | Component: tuple
Version: | Severity: Problem
Keywords: |
-------------------------------------------------------+--------------------
In the '''Boost Tuple Users Guide'''
''(/trunk/libs/tuple/doc/tuple_users_guide.html)'', I suggest the
following
changes.
In the ''The make_tuple function'' section:
{{{
(see the fifth code line below)
}}}
should be
{{{
(see the sixth code line below)
}}}
In the ''Accessing tuple elements'' section:
{{{
Violations of these constrains are...
}}}
should be
{{{
Violations of these constraints are...
}}}
and
{{{
...when writing code that shoud compile with MSVC++ 6.0.
}}}
should be
{{{
...when writing code that should compile with MSVC++ 6.0.
}}}
In the ''Performance'' section:
{{{
...using hand written tuple like classes.
}}}
should be
{{{
...using hand-written tuple-like classes.
}}}
In the ''Effect on Compile Time'' section:
{{{
Compile time increases between 5 to 10 percentages...
}}}
should be
{{{
Compile time increases between 5 and 10 percent...
}}}
In the ''Streaming'' section:
{{{
cin >> tuples::set_open('[') >> tuples::set_close(']') >>
tules::set_delimiter(':');
}}}
should be
{{{
cin >> tuples::set_open('[') >> tuples::set_close(']') >>
tuples::set_delimiter(':');
}}}
[tules becomes tuples]
'''HTML Markup'''
After the line ''Note particularly that the following is perfectly ok:''
the text:
{{{
Y y;
tuple<char(&)[10], Y&>(a, y);
}}}
is enclosed both in a {{{<pre></pre>}}} block and a {{{<code></code>}}}
block. The {{{<pre></pre>}}} markup is illegal here and should be removed.
The same error appears two more times. First in the HTML markup after
''...the tuples subnamespace. For example:'' and then again after ''The
code:''
There are several instances where < or > characters are used and should be
replaced with the character references < and >. An HTML validator
will
point them out.
In '''Tuple library advanced features'''
(''/trunk/libs/tuple/doc/tuple_advanced_interface.html''):
{{{
...nonmeber and member get functions...
}}}
should be
{{{
...nonmember and member get functions...
}}}
'''HTML Markup'''
The {{{<body bgcolor="#FFFFFF" text="#000000">}}} tag appears within the
{{{<head></head>}}} section of the page and must be moved to a position
after the {{{</head>}}} tag. The {{{<body>}}} tag is superfluous.
Also, the tag {{{<IMG SRC="../../../boost.png" ALT="C++ Boost" width="277"
height="86">}}} must be moved to a position within the {{{<body></body>}}}
section.
After ''The internal representation of the empty tuple...'' the markup
{{{
tuple<>
}}}
should be
{{{
tuple<>
}}}
[Adding a trailing semicolon.]
There are five instances in which a {{{<pre></pre>}}} block is nested
inside a {{{<code></code>}}} or a {{{<code></code>}}} block is nested
inside a {{{<pre></pre>}}} block. The {{{<pre></pre>}}} blocks should be
removed so that the computer code resides only within a
{{{<code></code>}}} block. A pass of the page through an HTML validator
will point out this and other problem areas.
Six instances of erroneous {{{<pre></pre>}}} blocks also exist in the
'''Tuple Library : design decisions rationale''' page
(''/trunk/libs/tuple/doc/design_decisions_rationale.html'').
Also on that design decisions rationale page in the parenthetical phrase
after ''Other orderings were considered, mainly dominance...'' the HTML
markup contains
{{{
<b(i)
}}}
which should be changed to
{{{
<b(i)
}}}
The {{{<!DOCTYPE>}}} tag is missing on the page.
--
Ticket URL: <http://svn.boost.org/trac/boost/ticket/1607>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.
This archive was generated by hypermail 2.1.7 : 2017-02-16 18:49:57 UTC