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

Update docs for assert! and debug_assert! #35072

Merged
merged 4 commits into from
Jul 29, 2016
Merged

Conversation

munyari
Copy link
Contributor

@munyari munyari commented Jul 27, 2016

Refer to #34455

@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 @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. 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.

/// evaluated to `true` at runtime.
/// This will ensure the termination of the program if the provided expression
/// cannot be evaluated to `true` at runtime by means of an unrecoverable error
/// (not necessarily a `panic!`, can also be an `abort`).
Copy link
Member

Choose a reason for hiding this comment

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

So, here's my one concern with this wording: it will always panic, the key is that panic can be either unwinding or abort. I would just stick to saying that this panics.

@steveklabnik
Copy link
Member

Thanks so much! I've left a few comments; this is a solid start, just some minor tweaks 😄

@steveklabnik steveklabnik assigned steveklabnik and unassigned aturon Jul 27, 2016
@munyari
Copy link
Contributor Author

munyari commented Jul 27, 2016

Thanks @steveklabnik, I've responded to each of your comments

@steveklabnik
Copy link
Member

Looks fantastic, thank you so much!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jul 27, 2016

📌 Commit 9a7367b has been approved by steveklabnik

@munyari
Copy link
Contributor Author

munyari commented Jul 27, 2016

My first merged PR to rust! 🎉

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jul 29, 2016
bors added a commit that referenced this pull request Jul 29, 2016
Rollup of 7 pull requests

- Successful merges: #34258, #34894, #35050, #35062, #35066, #35072, #35087
- Failed merges:
@bors
Copy link
Contributor

bors commented Jul 29, 2016

☔ The latest upstream changes (presumably #35100) made this pull request unmergeable. Please resolve the merge conflicts.

@bors bors merged commit 9a7367b into rust-lang:master Jul 29, 2016
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