Opened 7 years ago

Closed 7 years ago

#11409 closed Bugs (fixed)

Inconsistent documentation between the source code and its tutorial

Reported by: Anmol Singh Jaggi <raunaks.65@…> Owned by: Beman Dawes
Milestone: To Be Determined Component: filesystem
Version: Boost Development Trunk Severity: Problem
Keywords: documentation tutorial inconsistent Cc:

Description

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

Change History (1)

comment:1 by Beman Dawes, 7 years ago

Resolution: fixed
Status: newclosed

Thanks for the report. It caused me to rework the tutorial to modernize it and fix both this problem and a number of other problems.

The revised tutorial should ship as part of Boost 1.59.0 in a week or two.

--Beman

Note: See TracTickets for help on using tickets.