# Resolve docs inconsistency with Overflow builtins · gitcafe/zig

[View on GitCafe](https://git.cafe/gitcafe/zig/commit/4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99)

Repository: [gitcafe/zig](https://git.cafe/gitcafe/zig)

Visibility: public

Requested revision: 4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99

Requested commit: 4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99

Commit: 4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99

Tree: 35ad35e77e2f9266e4b1bbff873d1adfe378e23e

Author: Hashi364

Committer: GitHub

## Message

```
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>
```

## Parents

- [adc6dec26b8ba9f79aabc4b69ae689acf4c6767d](https://git.cafe/gitcafe/zig/commit/adc6dec26b8ba9f79aabc4b69ae689acf4c6767d?format=markdown)

[Source at this commit](https://git.cafe/gitcafe/zig/tree/4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99?format=markdown)
