More clarity in the example for VecDeque.get

[amarao]

Location

https://doc.rust-lang.org/std/collections/struct.VecDeque.html#method.get

Summary

There is a bit of ambiguity about 'front' and 'back' thing in VecDeque, and documentation example fuel this uncertainty a bit:

let mut buf = VecDeque::new();
buf.push_back(3);
buf.push_back(4);
buf.push_back(5);
assert_eq!(buf.get(1), Some(&4));

Is get counts from top or from bottom? Basically, from this example it's hard to get simple answer, what buf.get(2) would be, 3 or 5?

I understand, that deeper thinking may lead to a proper conclusion, but, by adding one more line buf.push_back(6); can clarify it without causing any doubts.

My proposal is to change it to

let mut buf = VecDeque::new();
buf.push_back(3);
buf.push_back(4);
buf.push_back(5);
buf.push_back(6);
assert_eq!(buf.get(1), Some(&4));

In this example there is only one way to interpret 'offset 1' without any ambiguity.

[clubby789]

The documentation for that method specifies Element at index 0 is the front of the queue., which is pretty explicit

[amarao]

Yes, but explicit example without false symmetry will make it easier to read. What's the point for an example to provide ambiguity?

[amarao]

Thank you!