[Boost-bugs] [Boost C++ Libraries] #11409: Inconsistent documentation between the source code and its tutorial

Subject: [Boost-bugs] [Boost C++ Libraries] #11409: Inconsistent documentation between the source code and its tutorial
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2015-06-21 11:24:32

#11409: Inconsistent documentation between the source code and its tutorial
-------------------------------------------------+------------------------
 Reporter:  Anmol Singh Jaggi <raunaks.65@…>     |      Owner:  bemandawes
     Type:  Bugs                                 |     Status:  new
Milestone:  To Be Determined                     |  Component:  filesystem
  Version:  Boost Development Trunk              |   Severity:  Problem
 Keywords:  documentation tutorial inconsistent  |
-------------------------------------------------+------------------------
 The tutorial given at
 [http://www.boost.org/doc/libs/1_58_0/libs/filesystem/doc/tutorial.html

 #Using-path-decomposition] is inconsistent with its tutorial.

 {{{
 cout << "   " << *it << '\n';
 }}}

 outputs the complete path of the file rather than just its name as is
 shown in its example output.

 Therefore, the correct statement should be -:
 {{{
 cout << "   " << it->filename() << '\n';
 }}}

 The accompanying explanation is changed accordingly as well.

 I have already created a pull request for this -:
 [https://github.com/boostorg/filesystem/pull/11/commits]

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