authorgravatar for 49736221+Kiyoshi364@users.noreply.github.comHashi364 <49736221+Kiyoshi364@users.noreply.github.com> 2023-03-13 11:47:20-03:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2023-03-13 14:47:20+00:00
log4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99
tree35ad35e77e2f9266e4b1bbff873d1adfe378e23e
parentadc6dec26b8ba9f79aabc4b69ae689acf4c6767d
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Resolve docs inconsistency with Overflow builtins

In 41 (Undefined Behavior) . 5 (Integer Overflow) . 3 (Builtin Overflow Functions), it is stated that > These builtins return a bool of whether or not overflow occurred, as well as returning the overflowed bits: > * @addWithOverflow > * @subWithOverflow > * @mulWithOverflow > * @shlWithOverflow but in their definition says that it returns a `tuple`/`struct`. Example; `@addWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }` Co-authored-by: zooster <r00ster91@proton.me>

1 files changed, 2 insertions(+), 2 deletions(-)

doc/langref.html.in+2-2
...@@ -9804,8 +9804,8 @@ pub fn main() !void {...@@ -9804,8 +9804,8 @@ pub fn main() !void {
9804 {#header_close#}9804 {#header_close#}
9805 {#header_open|Builtin Overflow Functions#}9805 {#header_open|Builtin Overflow Functions#}
9806 <p>9806 <p>
9807 These builtins return a {#syntax#}bool{#endsyntax#} of whether or not overflow9807 These builtins return a tuple containing whether there was an overflow
9808 occurred, as well as returning the overflowed bits:9808 (as a {#syntax#}u1{#endsyntax#}) and the possibly overflowed bits of the operation:
9809 </p>9809 </p>
9810 <ul>9810 <ul>
9811 <li>{#link|@addWithOverflow#}</li>9811 <li>{#link|@addWithOverflow#}</li>