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

improve docs for std::hint::unreachable_unchecked() #59717

Merged
merged 2 commits into from
Apr 16, 2019
Merged

improve docs for std::hint::unreachable_unchecked() #59717

merged 2 commits into from
Apr 16, 2019

Conversation

Reconcyl
Copy link

@Reconcyl Reconcyl commented Apr 5, 2019

Fixes #59549

@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 @Mark-Simulacrum (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.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 5, 2019
@Mark-Simulacrum
Copy link
Member

r? @steveklabnik

///
/// The [`unreachable!()`] macro is the safe counterpart of this function, which
/// will panic instead when executed.
/// Otherwise, consider using the [`unreachable!()`] macro, which does not allow
Copy link
Member

Choose a reason for hiding this comment

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

This is good, but can you remove the ()s, both here and in the link target? I know they were there previously, but the style is not to include them when referring to the names.

Copy link
Author

Choose a reason for hiding this comment

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

I added another commit to address this.

@Dylan-DPC-zz
Copy link

@bors r=steveklabnik

@bors
Copy link
Contributor

bors commented Apr 15, 2019

📌 Commit 62a7bfd has been approved by steveklabnik

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 15, 2019
Centril added a commit to Centril/rust that referenced this pull request Apr 15, 2019
improve docs for std::hint::unreachable_unchecked()

Fixes rust-lang#59549
Centril added a commit to Centril/rust that referenced this pull request Apr 16, 2019
improve docs for std::hint::unreachable_unchecked()

Fixes rust-lang#59549
Centril added a commit to Centril/rust that referenced this pull request Apr 16, 2019
improve docs for std::hint::unreachable_unchecked()

Fixes rust-lang#59549
bors added a commit that referenced this pull request Apr 16, 2019
Rollup of 6 pull requests

Successful merges:

 - #59717 (improve docs for std::hint::unreachable_unchecked())
 - #59903 (Continue evaluating after missing main)
 - #59973 (Fix rustdoc sidebar z-index)
 - #59992 (rustdoc: use --static-root-path for settings.js)
 - #59993 (include mode in unused binding suggestion span)
 - #60000 (Add repo-specific triagebot configuration)

Failed merges:

r? @ghost
@bors bors merged commit 62a7bfd into rust-lang:master Apr 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing wording in documentation for std::hint::unreachable_unchecked()
6 participants