Confusing wording in documentation for std::hint::unreachable_unchecked() #59549
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
E-help-wanted
Call for participation: Help is requested to fix this issue.
The documentation for
std::hint::unreachable_unchecked()
mentions two ways that it can affect a program:It then goes on to mention the
unreachable!()
macro, sayingThis statement could be read as addressing the 2nd effect, but not the 1st. In other words, it could be interpreted as saying "the compiler will assume that
unreachable!()
will never be executed, but in the event that it is it will cause a panic." It might be worth rewording this statement to make it clear that neither (1) nor (2) applies to the safe version.The text was updated successfully, but these errors were encountered: