[Boost-bugs] [Boost C++ Libraries] #1877: Documentation Corrections - Archive Concepts

Subject: [Boost-bugs] [Boost C++ Libraries] #1877: Documentation Corrections - Archive Concepts
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-04-28 20:08:11

#1877: Documentation Corrections - Archive Concepts
-------------------------------------------------------+--------------------
 Reporter:  Charles Brockman <cmbrockman_at_[hidden]>  |       Owner:  ramey        
     Type:  Bugs                                       |      Status:  new          
Milestone:  Boost 1.36.0                               |   Component:  serialization
  Version:  Boost Development Trunk                    |    Severity:  Problem      
 Keywords:  archive concepts documentation             |  
-------------------------------------------------------+--------------------
 In the Archive Concepts documentation
 (''/libs/serialization/doc/archives.html'') the following errors exist:

 "...a sequence of bytes correpsonding to..." should be
 "...a sequence of bytes corresponding to..."

 "...set of C++ data structures the is equivalent to..." should be
 "...set of C++ data structures that is equivalent to..."

 "...the way the data is are rendered..." should be
 "...the way the data are rendered..."

 In the sa.library_version() and  la.library_version() sections, consider
 the phrase "This number will be incremented each time the library is
 altered..." Is the 'library' referred to the Boost Serialization Library
 or another entity? Would the word 'archive' be better here? Who does the
 version number incrementing? Is it automatic? Perhaps a cross reference to
 ''/libs/serialization/doc/tutorial.html#versioning'' would be sufficient.

 "...and later moved to another location, This function..." should be
 "...and later moved to another location, this function..."

 "This is permits the the archive to..." should be
 "This permits the archive to..."
 [Two changes.]

 "The existence of the << and >> suggest a relationship..." should be
 "The existence of << and >> suggests a relationship..."
 [Two changes.]

 "This library includes a various implementation of the Archive concept."
 should be
 "This library includes various implementations of the Archive concept."
 [Two changes.]

 "Contructs an archive given..." should be
 "Constructs an archive given..."

 "...to thier state before the the archive was opened." should be
 "...to their state before the archive was opened."
 [Two changes.]

 "The list of exceptions that might be throw can..." should be
 "The list of exceptions that might be thrown can..."

 "...renders it output as UTF-8 which..." should be
 "...renders its output as UTF-8 which..."

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