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

doc: a few minor style fixes #16241

Merged
merged 1 commit into from
Aug 19, 2014
Merged

doc: a few minor style fixes #16241

merged 1 commit into from
Aug 19, 2014

Conversation

ftxqxd
Copy link
Contributor

@ftxqxd ftxqxd commented Aug 4, 2014

For crates alloccollections. 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)).

//! 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.
Copy link
Member

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.

@steveklabnik
Copy link
Member

Wow, what a diff. Thank you so much.

@alexcrichton
Copy link
Member

ping @P1start, is this ready to go with a rebase?

@ftxqxd
Copy link
Contributor Author

ftxqxd commented Aug 19, 2014

@alexcrichton Rebased. This should be good to go now.

@alexcrichton
Copy link
Member

r? @steveklabnik

@steveklabnik
Copy link
Member

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.

bors added a commit that referenced this pull request Aug 19, 2014
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)).
@bors bors closed this Aug 19, 2014
@bors bors merged commit f2aa88c into rust-lang:master Aug 19, 2014
@ftxqxd ftxqxd deleted the doc-fixes branch August 20, 2014 03:00
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 8, 2024
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.
@bitfield bitfield mentioned this pull request Jul 18, 2024
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 this pull request may close these issues.

4 participants