[Boost-bugs] [Boost C++ Libraries] #4718: date::day_of_week documentation is unhelpful

Subject: [Boost-bugs] [Boost C++ Libraries] #4718: date::day_of_week documentation is unhelpful
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-10-07 16:56:14

#4718: date::day_of_week documentation is unhelpful
-------------------------------------+--------------------------------------
 Reporter:  russell.silva@…          |       Owner:  matias       
     Type:  Bugs                     |      Status:  new          
Milestone:  To Be Determined         |   Component:  Documentation
  Version:  Boost 1.44.0             |    Severity:  Problem      
 Keywords:                           |  
-------------------------------------+--------------------------------------
 The Gregorian date documentation for the day_of_week method is unhelpful.
 It's not clear what the return type of the method is; it's not immediately
 obvious what a greg_day_of_week is.  The example does not help, since it
 does not use the method at all.  It turns out that the method returns an
 integer, but there is no documentation as to which day corresponds to
 which integer return value.

 http://www.boost.org/doc/libs/1_43_0/doc/html/date_time/gregorian.html#date_time.gregorian.date_class

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