Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the name of RingBuf #22361

Closed
EdorianDark opened this issue Feb 15, 2015 · 0 comments · Fixed by #22457
Closed

Document the name of RingBuf #22361

EdorianDark opened this issue Feb 15, 2015 · 0 comments · Fixed by #22457

Comments

@EdorianDark
Copy link
Contributor

Currently the different collections are named after the implementation (RingBuf or BinaryHeap) and not the concept they implement (double ended queue or priority queue).

In some explanations of ring buffers (http://en.wikipedia.org/wiki/Circular_buffer) it is defined that adding elements to a full ring buffer leads to overwrite of elements. This seems not to be the case here.

Therefore I would suggest to change the introduction of the ring buffer documentation to:

RingBuf is a double- ended queue, which is implemented with the help of a growing circular buffer.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 17, 2015
alexcrichton added a commit to alexcrichton/rust that referenced this issue Feb 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants