[Boost-bugs] [Boost C++ Libraries] #1937: Boost.Filesystem documentation and tutorial needs

Subject: [Boost-bugs] [Boost C++ Libraries] #1937: Boost.Filesystem documentation and tutorial needs
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-05-20 13:15:22

#1937: Boost.Filesystem documentation and tutorial needs
--------------------------+-------------------------------------------------
 Reporter:  bemandawes    |       Owner:  bemandawes
     Type:  Tasks         |      Status:  new       
Milestone:  Boost 1.36.0  |   Component:  filesystem
  Version:  Boost 1.35.0  |    Severity:  Problem   
 Keywords:                |  
--------------------------+-------------------------------------------------
 The documentation for Boost.Filesystem uses the phrase "implementation
 defined" in at least one place without subsequently defining whatever it
 is (see the pathname grammar).  Since these docs have to describe a
 particular implementation and not just be a prototype for
 standardization, don't we need to fill in the details?

 I also wonder if adhering to the standard documentation form for
 reference materials really makes this library accessible enough for
 general use.  Even understanding the first example program ("simple ls")
 requires me to read through a great deal of reference material to
 understand what's going on.  Maybe that just means a more complete
 tutorial is needed?

 -- Dave Abrahams BoostPro Computing http://www.boostpro.com


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