Docs for fetch_add/fetch_sub/pow and overflow behavior #40916
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
Comments
|
The default behavior for overflow is "panic in debug mode, wrap in release mode." So anything that does that does not need a note. Anything else should get one. |
|
In that case, we must add a note for |
|
Dupe of #34618? |
|
Yeah just adding a note here about overflow should be fine, but yeah looks like a dupe of #34618 so closing |
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 2, 2017
… r=alexcrichton Add a note about overflow for fetch_add/fetch_sub Fixes rust-lang#40916 r? @steveklabnik
bors
added a commit
that referenced
this issue
Apr 2, 2017
…hton Add a note about overflow for fetch_add/fetch_sub Fixes #40916 Fixes #34618 r? @steveklabnik
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 3, 2017
… r=alexcrichton Add a note about overflow for fetch_add/fetch_sub Fixes rust-lang#40916 Fixes rust-lang#34618 r? @steveklabnik
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 3, 2017
… r=alexcrichton Add a note about overflow for fetch_add/fetch_sub Fixes rust-lang#40916 Fixes rust-lang#34618 r? @steveklabnik
arielb1
pushed a commit
to arielb1/rust
that referenced
this issue
Apr 5, 2017
… r=alexcrichton Add a note about overflow for fetch_add/fetch_sub Fixes rust-lang#40916 Fixes rust-lang#34618 r? @steveklabnik
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
fetch_add fetch_sub pow
Do docs for those methods need to explain what happens on overflow? There are three possible overflow behaviors: panic, saturate, wrap. Is it obvious what those methods do on overflow?
Perhaps we should explain? I guess
fetch_addandfetch_subwrap around, whilepowpanics in debug mode and wraps around in release mode.cc @alexcrichton
The text was updated successfully, but these errors were encountered: