Re: [Boost-bugs] [Boost C++ Libraries] #4195: boost::circular_buffer documentation error

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #4195: boost::circular_buffer documentation error
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-05-19 16:22:48


#4195: boost::circular_buffer documentation error
---------------------------+------------------------------------------------
  Reporter: anonymous | Owner: jano_gaspar
      Type: Bugs | Status: closed
 Milestone: Boost 1.43.0 | Component: circular_buffer
   Version: Boost 1.42.0 | Severity: Cosmetic
Resolution: worksforme | Keywords:
---------------------------+------------------------------------------------
Changes (by anonymous):

  * status: new => closed
  * resolution: => worksforme

Comment:

 Replying to [comment:1 nstewart@…]:
> I don't see how the documentation implies bytes. In C++ it's normal for
 "size" to refer to the number of elements. Such as std::vector<T>::size.
>
> Requesting clarification - can you be more specific?

 The documentation gives the following example.

 int write(int file_desc, char* buff, int num_bytes);
 array_range ar = buff.array_one();
 write(file_desc, ar.first, ar.second);
 ar = buff.array_two();
 write(file_desc, ar.first, ar.second);

 The num_bytes implied to me that circular_buffer::array_one::second
 returns the number of bytes.

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

This archive was generated by hypermail 2.1.7 : 2017-02-16 18:50:03 UTC