Skip to content

Describe VecDeque with more consistent names #93899

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
Feb 15, 2022

Conversation

ssomers
Copy link
Contributor

@ssomers ssomers commented Feb 11, 2022

The public documentation of VecDeque starts describing itself as a "queue". In method descriptions, it's never sometimes named queue again, or VecDeque (IMO a sometimes useful and often noisy notation) or "deque" or "vector". In examples, deque, v (hidden in range_mut) or vector. Here is a subjective attempt at more consistency.

@rust-highfive
Copy link
Contributor

r? @yaahc

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 11, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Feb 13, 2022

It might be good to introduce the word deque in the doc text of the VecDeque type. Maybe somnething like this in the first sentence:

- A double-ended queue implemented with a growable ring buffer.
+ A double-ended queue (deque) implemented with a growable ring buffer.

@m-ou-se m-ou-se assigned m-ou-se and unassigned yaahc Feb 13, 2022
@m-ou-se m-ou-se added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Feb 13, 2022
@ssomers
Copy link
Contributor Author

ssomers commented Feb 14, 2022

It might be good to introduce the word deque

It is indeed.

@ssomers
Copy link
Contributor Author

ssomers commented Feb 14, 2022

Oops, only now I noticed that I did find and replace the word "queue", leading to the unfortunate description "double-ended deque". Fixed.

@m-ou-se
Copy link
Member

m-ou-se commented Feb 14, 2022

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Feb 14, 2022

📌 Commit 5d53597 has been approved by m-ou-se

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 14, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 15, 2022
…askrgr

Rollup of 5 pull requests

Successful merges:

 - rust-lang#93899 (Describe VecDeque with more consistent names)
 - rust-lang#93949 (Add basic platform support to library/{panic_}unwind for m68k)
 - rust-lang#93999 (suggest using raw strings when invalid escapes appear in literals)
 - rust-lang#94001 (llvm: migrate to new parameter-bearing uwtable attr)
 - rust-lang#94014 (Move transmute_undefined_repr back to nursery)

Failed merges:

 - rust-lang#94020 (Support pretty printing of invalid constants)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit cdfdcfc into rust-lang:master Feb 15, 2022
@rustbot rustbot added this to the 1.60.0 milestone Feb 15, 2022
@ssomers ssomers deleted the vecdeque_naming branch February 16, 2022 11:51
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants