Skip to content

doc: a few minor style fixes#16241

Merged
bors merged 1 commit intorust-lang:masterfrom
ftxqxd:doc-fixes
Aug 19, 2014
Merged

doc: a few minor style fixes#16241
bors merged 1 commit intorust-lang:masterfrom
ftxqxd:doc-fixes

Conversation

@ftxqxd
Copy link
Copy Markdown
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)).

Comment thread src/liballoc/lib.rs Outdated
Copy link
Copy Markdown
Contributor

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
Copy Markdown
Contributor

Wow, what a diff. Thank you so much.

@alexcrichton
Copy link
Copy Markdown
Member

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

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