Modify

Ticket #8460 (closed Bugs: fixed)

Opened 12 months ago

Last modified 11 months ago

Doc errors

Reported by: Richard Hadsell <hadsell@…> Owned by: danieljames
Milestone: To Be Determined Component: iostreams
Version: Boost 1.53.0 Severity: Cosmetic
Keywords: Cc:

Description

I'm just starting to read the Boost.Iostreams documentation and found some minor errors. Perhaps someone would like to make these trivial corrections to help other novices in the future.

(1) 2.1.4. In the implementation of container_device::write, the block that writes remaining characters at the end of the container ("if (result < n) { ... }") should insert characters from 's + result', not from 's': "container_.insert(container_.end(), s + result, s + n);".

(2) 2.1.4. In the implementation of container_device::seek, there are 3 uses of "ios_bas" instead of "ios_base".

(3) 2.1.4. c/striaghforward/straightforward

(4) Function Template tee In the Description section second paragraph, "Device" should be "Sink" (should be "given a Sink or a pair of Sinks").

Attachments

Change History

comment:1 Changed 12 months ago by Richard Hadsell <hadsell@…>

(5) Function Template putback: In the Overview, "put" should be "putback".

comment:2 Changed 12 months ago by Richard Hadsell <hadsell@…>

(6) Function Template get: In the Example, "(c == boost::iostreams::get(src))" should be "(c = boost::iostreams::get(src))". It should be an assignment, not a comparison.

comment:3 Changed 12 months ago by Richard Hadsell <hadsell@…>

(7) Class Template filtering_stream: The heading "filtering_stream::push" does not belong embedded in the description of the constructors. It appears just after the description of the default constructor.

comment:4 Changed 12 months ago by Richard Hadsell <hadsell@…>

(8) In Quick Reference: In the Core Components table, the entry for "filtering_streambuf" links to the Class Template filtering_stream page instead of filtering_streambuf.

comment:5 Changed 12 months ago by Richard Hadsell <hadsell@…>

(9) Class Template filtering_streambuf: There is an errant heading "filtering_streambuf::push" equivalent to error (7) above.

comment:6 Changed 12 months ago by danieljames

(In [84161]) Fix iostream doc errors. Refs #8460

comment:7 Changed 12 months ago by danieljames

  • Owner changed from turkanis to danieljames
  • Status changed from new to assigned

comment:8 Changed 11 months ago by danieljames

  • Status changed from assigned to closed
  • Resolution set to fixed

(In [84303]) Merge iostreams to release. Fixes #8315, #8385, #8460.

Not merging the fallthrough macro, as config support hasn't been merged yet. And not merging the build changes, as I don't know if they're ready.

View

Add a comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
The resolution will be deleted. Next status will be 'reopened'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.