Modify

Opened 5 years ago

Closed 5 years ago

#8460 closed Bugs (fixed)

Doc errors

Reported by: Richard Hadsell <hadsell@…> Owned by: Daniel James
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 (0)

Change History (8)

comment:1 Changed 5 years ago by Richard Hadsell <hadsell@…>

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

comment:2 Changed 5 years 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 5 years 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 5 years 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 5 years 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 5 years ago by Daniel James

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

comment:7 Changed 5 years ago by Daniel James

Owner: changed from Jonathan Turkanis to Daniel James
Status: newassigned

comment:8 Changed 5 years ago by Daniel James

Resolution: fixed
Status: assignedclosed

(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.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Daniel James.
The resolution will be deleted.

Add Comment


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

 
Note: See TracTickets for help on using tickets.