-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
docs: improve disclaimer regarding LinkedList #65574
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
r? @Centril |
r=me rollup when green. |
(Also, note for the future: It's best to avoid @-pinging folks since it tends to generate more notifications when rebasing etc.) |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
a458a4a
to
7c08bea
Compare
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
7c08bea
to
9fdc913
Compare
r? @Centril |
//! Almost always it is better to use `Vec` or [`VecDeque`] instead of | ||
//! [`LinkedList`]. In general, array-based containers are faster, | ||
//! more memory efficient and make better use of CPU cache. | ||
//! NOTE: It is almost always better to use [`Vec`] or [`VecDeque`]... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the ...
at the end now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A period (.
) feels abrupt. The ...
indicates a gentle connection between the before (claim) and after (justification).
Also, am sure there's a better explanation why people use ...
, which is something of a subtle concept.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I often use "..." in casual conversation because it suggests that I'm not done thinking; it's a sort of "uhm", "eh". but in a more formal setting (i.e. standards documentation) it just feels sloppy. See also https://en.wikipedia.org/wiki/Speech_disfluency and https://en.wikipedia.org/wiki/Filler_(linguistics).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternative:
NOTE: It is almost always better to use
Vec
orVecDeque
because array-based containers are generally faster...
As a sidenote, and assuming you like that better, do you think we should add a comma there...
NOTE: It is almost always better to use
Vec
orVecDeque
, because array-based containers are generally faster...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first alternative is fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is done
9fdc913
to
a844e59
Compare
@bors r+ rollup |
📌 Commit a844e59 has been approved by |
…Centril docs: improve disclaimer regarding LinkedList
Rollup of 10 pull requests Successful merges: - #65136 (Update codegen option documentation.) - #65574 (docs: improve disclaimer regarding LinkedList) - #65720 (Add FFI bindings for LLVM's Module::getInstructionCount()) - #65905 ([doc] fixes for unix/vxworks `OpenOptionsExt::mode`) - #65962 (Fix logic in example.) - #66019 (Improved std::iter::Chain documentation) - #66038 (doc(str): show example of chars().count() under len()) - #66042 (Suggest correct code when encountering an incorrect trait bound referencing the current trait) - #66073 (Do not needlessly write-lock) - #66096 (Add a failing UI test for multiple loops of all kinds in a `const`) Failed merges: r? @ghost
No description provided.