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

Dlist examples #21126

Merged
merged 1 commit into from
Jan 16, 2015
Merged

Dlist examples #21126

merged 1 commit into from
Jan 16, 2015

Conversation

sleepynate
Copy link
Contributor

Just some documentation test examples for the DList collection.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @gankro (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see CONTRIBUTING.md for more information.

///
/// # Examples
///
/// ```rust
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've been leaving off the 'rust' in these examples. It defaults to rust, but it's nice to have when the code blocks are by themselves, ie, in the longform docs. But since this is embedded inside of a Rust comment, Github doesn't highlihght them anyway, so it's just noise.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So three backticks, without "rust" after them is the preferred example syntax for the future? I just borrowed from the other examples in the file.

@steveklabnik
Copy link
Member

This looks great! Just two small nits. After that, and a squash, r=me

bors added a commit that referenced this pull request Jan 14, 2015
Dlist examples

Reviewed-by: steveklabnik
bors added a commit that referenced this pull request Jan 15, 2015
Dlist examples

Reviewed-by: steveklabnik
bors added a commit that referenced this pull request Jan 15, 2015
Dlist examples

Reviewed-by: steveklabnik
alexcrichton added a commit to alexcrichton/rust that referenced this pull request Jan 15, 2015
Just some documentation test examples for the DList collection.
@bors bors merged commit fb55628 into rust-lang:master Jan 16, 2015
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.

5 participants