[Boost-bugs] [Boost C++ Libraries] #1893: Documentation Corrections to map.html

Subject: [Boost-bugs] [Boost C++ Libraries] #1893: Documentation Corrections to map.html
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-05-03 23:02:14

#1893: Documentation Corrections to map.html
-------------------------------------------------------+--------------------
 Reporter:  Charles Brockman <cmbrockman_at_[hidden]>  |       Owner:  djowel 
     Type:  Bugs                                       |      Status:  new    
Milestone:  Boost 1.36.0                               |   Component:  fusion 
  Version:  Boost Development Trunk                    |    Severity:  Problem
 Keywords:                                             |  
-------------------------------------------------------+--------------------
 On the /trunk/libs/fusion/doc/html/fusion/container/map.html page in the
 ''Description'' section:[[BR]]
 "...heteregenous typed data elements."[[BR]]
 should be[[BR]]
 "...heterogenous-typed data elements."[[BR]]or[[BR]]
 "...heterogeneous-typed data elements." (the spelling used in the ''Model
 of'' section below)

 In the ''Header'' section:[[BR]]
 #include <boost/fusion/container/map_fwd.hpp>[[BR]]
 should be changed to[[BR]]
 #include <boost/fusion/container/map/map_fwd.hpp>

 In the ''Synopsis'' section we read:[[BR]]
 "You may define the preprocessor constant FUSION_MAX_MAP_SIZE..."[[BR]]
 but note 9 at the bottom of
 /trunk/libs/fusion/doc/html/fusion/container/generation/functions/make_map.html
 and note 12 at the bottom of
 /trunk/libs/fusion/doc/html/fusion/container/generation/metafunctions/make_map.html
 both state[[BR]]
 "map is implemented in terms of the vector. That is why we reuse
 FUSION_MAX_VECTOR_SIZE."[[BR]]
 (See also http://lists.boost.org/boost-users/2007/03/26406.php)
 [[BR]]
 Perhaps the reference to FUSION_MAX_MAP_SIZE on the map.html page should
 be changed to FUSION_MAX_VECTOR_SIZE or the references on both
 make_map.html pages should be changed to FUSION_MAX_MAP_SIZE.

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