-
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
doc: a few minor style fixes #16241
doc: a few minor style fixes #16241
Conversation
//! is just a pointer. Tree-like data structures are often built on owned | ||
//! pointers because each node often has only one owner, the parent. | ||
//! is the same as that of a pointer. Tree-like data structures are often built | ||
//! on owned pointers because each node often has only one owner, the parent. |
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.
"owned pointers" is no longer a thing, I would say
Tree-like data structures are often build with boxes because each node has only one owner, the parent.
Wow, what a diff. Thank you so much. |
ping @P1start, is this ready to go with a rebase? |
@alexcrichton Rebased. This should be good to go now. |
This is a massive diff, and I'm on a plane all day today. It looks like my concerns were all addressed, so if you're happy, @alexcrichton , then yes, r=me. Otherwise, I can re-read the entire diff again in a day or two. |
For crates `alloc`–`collections`. This is mostly just updating a few function/method descriptions to use the indicative style. cc #4361; I’ve sort of assumed that the third-person indicative style has been decided on, but I could update this to use the imperative style if that’s preferred, or even update this to remove all function-style-related changes. (I think that standardising on one thing, even if it’s not the ‘best’ option, is still better than having no standard at all.) The indicative style seems to be more common in the Rust standard library at the moment, especially in the newer modules (e.g. `collections::vec`), more popular in the discussion about it, and also more popular amongst other languages (see #4361 (comment)).
Give a userful error when rustc cannot be found in explicit sysroot Somehow r-a believed that my sysroot was something weird with no rustc. Probably a me issue, but it was impossible to diagnose since r-a just gave me a plain "No such file or directory". Adding this error makes it clear what happened and allows diagnosing the problem.
For crates
alloc
–collections
. This is mostly just updating a few function/method descriptions to use the indicative style.cc #4361; I’ve sort of assumed that the third-person indicative style has been decided on, but I could update this to use the imperative style if that’s preferred, or even update this to remove all function-style-related changes. (I think that standardising on one thing, even if it’s not the ‘best’ option, is still better than having no standard at all.) The indicative style seems to be more common in the Rust standard library at the moment, especially in the newer modules (e.g.
collections::vec
), more popular in the discussion about it, and also more popular amongst other languages (see #4361 (comment)).