[Boost-bugs] [Boost C++ Libraries] #1878: Documention Corrections - Various date_time Pages

Subject: [Boost-bugs] [Boost C++ Libraries] #1878: Documention Corrections - Various date_time Pages
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-04-28 22:18:08

#1878: Documention Corrections - Various date_time Pages
-------------------------------------------------------+--------------------
 Reporter:  Charles Brockman <cmbrockman_at_[hidden]>  |       Owner:  az_sw_dude
     Type:  Bugs                                       |      Status:  new       
Milestone:  Boost 1.36.0                               |   Component:  date_time 
  Version:  Boost Development Trunk                    |    Severity:  Problem   
 Keywords:                                             |  
-------------------------------------------------------+--------------------
 Here are some suggested changes for the ''date_time'' library
 documentation.

 In ''\libs\date_time\xmldoc\gregorian.xml'', the phrase[[BR]]
 "If you are interested in learning about writing programs do specialized
 date
 calculations..."[[BR]]
 should probably be[[BR]]
 "If you are interested in learning about writing programs that do
 specialized
 date calculations..."


 In ''\libs\date_time\xmldoc\date_class.xml'':[[BR]]
 "...it is not possible to construct and 'invalid' date."[[BR]]should
 be[[BR]]
 "...it is not possible to construct an 'invalid' date."

 <entry>Get the day of the week (eg: Sunday, Monday, etc.</entry>[[BR]]
 should be[[BR]]
 <entry>Get the day of the week (Sunday, Monday etc.)</entry>[[BR]]
 [closing the parentheses and removing the superfluous "eg"]

 <entry>To <code>YYYY-mmm-DD</code> string where <code>mmm</code> 3 char
 month
 name.</entry>[[BR]]
 should be[[BR]]
 <entry>To <code>YYYY-mmm-DD</code> string where <code>mmm</code> is a 3
 char
 month name.</entry>

 In the row after[[BR]]<entry valign="top" morerows="1"><screen>date
 operator-(date_duration) const</screen></entry>, I think the line should
 be
 changed from[[BR]]
 <entry>Return a date by adding a day offset</entry>[[BR]]
 to[[BR]]
 <entry>Return a date by subtracting a day offset</entry>


 Here are two items for
 ''\libs\date_time\xmldoc\snap_to_details.xml'':[[BR]]
 "The <link linkend="iterators_intro">month_iterator</link> is not effected
 by
 this issue..."
 [[BR]]should be[[BR]]
 "The <link linkend="iterators_intro">month_iterator</link> is not affected
 by
 this issue..."[[BR]]
 [effected = accomplished, affected = influenced]

 "This would cause the final result to be different that the starting
 date."
 [[BR]]should be[[BR]]
 "This would cause the final result to be different than the starting
 date."

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