improve @enumFromInt doc (#20354)

closes #19123
This commit is contained in:
kj4tmp 2024-07-21 02:41:43 -07:00 committed by GitHub
parent 1dbee05609
commit d484269543
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4710,8 +4710,11 @@ fn cmpxchgWeakButNotAtomic(comptime T: type, ptr: *T, expected_value: T, new_val
Converts an integer into an {#link|enum#} value. The return type is the inferred result type.
</p>
<p>
Attempting to convert an integer which represents no value in the chosen enum type invokes
Attempting to convert an integer with no corresponding value in the enum invokes
safety-checked {#link|Undefined Behavior#}.
Note that a {#link|non-exhaustive enum|Non-exhaustive enum#} has corresponding values for all
integers in the enum's integer tag type: the {#syntax#}_{#endsyntax#} value represents all
the remaining unnamed integers in the enum's tag type.
</p>
{#see_also|@intFromEnum#}
{#header_close#}