-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Conversation
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. |
src/libcore/hint.rs
Outdated
/// | ||
/// 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@bors r=steveklabnik |
📌 Commit 62a7bfd has been approved by |
improve docs for std::hint::unreachable_unchecked() Fixes rust-lang#59549
improve docs for std::hint::unreachable_unchecked() Fixes rust-lang#59549
improve docs for std::hint::unreachable_unchecked() Fixes rust-lang#59549
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
Fixes #59549