Skip to content

Add examples to methods on integer types #29712

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

Merged
merged 1 commit into from Nov 12, 2015
Merged

Add examples to methods on integer types #29712

merged 1 commit into from Nov 12, 2015

Conversation

ghost
Copy link

@ghost ghost commented Nov 9, 2015

Adds Example sections to the rest of the integer methods.

cc @steveklabnik

@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (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 the contribution instructions for more information.

@alexcrichton
Copy link
Member

@bors: r+ 4a31f3ddf9120a5758e22ad714fc688c89be4902

Thanks!

@steveklabnik
Copy link
Member

@bors: r-

this failed on travis: https://s3.amazonaws.com/archive.travis-ci.org/jobs/90055835/log.txt

plus i have some inline comments

///
/// # 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 don't use the rust in API documentation, can these be removed?

@ghost
Copy link
Author

ghost commented Nov 10, 2015

@steveklabnik I've addressed the inline comments :-)

@@ -140,6 +140,7 @@ macro_rules! int_impl {
/// Leading and trailing whitespace represent an error.
///
/// # Examples
/// Basic usage:
Copy link
Member

Choose a reason for hiding this comment

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

Oh, sorry, can you put a space between this and the # Examples? This is cramped, I know it still works markdown-wise

@steveklabnik
Copy link
Member

After travis passes and that one last nit, r=me

(Sorry for being so nit-picky, consistent style is hard)

@ghost
Copy link
Author

ghost commented Nov 11, 2015

@steveklabnik No problem at all; looks like Travis has passed

@ghost
Copy link
Author

ghost commented Nov 12, 2015

r? @steveklabnik

@rust-highfive rust-highfive assigned steveklabnik and unassigned aturon Nov 12, 2015
@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Nov 12, 2015

📌 Commit 5e68056 has been approved by steveklabnik

@steveklabnik
Copy link
Member

🎊

thanks so much again

@bors
Copy link
Collaborator

bors commented Nov 12, 2015

⌛ Testing commit 5e68056 with merge 15e7824...

bors added a commit that referenced this pull request Nov 12, 2015
Adds `Example` sections to the rest of the integer methods.

cc @steveklabnik
@bors bors merged commit 5e68056 into rust-lang:master Nov 12, 2015
@ghost ghost deleted the patch-1 branch November 12, 2015 23:08
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