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

Updated the primitive docs for bool #31843

Merged
merged 1 commit into from
Feb 25, 2016
Merged

Conversation

wafflespeanut
Copy link
Contributor

@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 @steveklabnik (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. Due to 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 the contribution instructions for more information.

/// # Examples
///
/// [`assert!`](std/macro.assert!.html), being an important macro in testing, checks
/// whether an expression returns `bool`.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe say "checks whether an expression results in true" here instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right :)

@@ -10,8 +10,46 @@

#[doc(primitive = "bool")]
//
/// The boolean type.
/// The boolean type represents a value, which could only be either `true` or `false`.
Copy link
Member

Choose a reason for hiding this comment

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

I would like to move this addition into the body, rather than being the main comment. Symmetry: http://doc.rust-lang.org/std/#primitives

@steveklabnik
Copy link
Member

A welcome improvement! Some more nits from me, now that I've had some time to digest :)

@steveklabnik
Copy link
Member

@bors: r+ rollup

Let's :shipit:

@bors
Copy link
Contributor

bors commented Feb 24, 2016

📌 Commit eb97c26 has been approved by steveklabnik

@wafflespeanut
Copy link
Contributor Author

Thanks! :)

Manishearth added a commit to Manishearth/rust that referenced this pull request Feb 24, 2016
bors added a commit that referenced this pull request Feb 24, 2016
@bors bors merged commit eb97c26 into rust-lang:master Feb 25, 2016
@wafflespeanut wafflespeanut deleted the bool_docs branch February 25, 2016 07:04
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.

API Docs: bool
5 participants