wrapping_rem
methods should document panic-on-zero
#116063
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
Libs-Small
Libs issues that are considered "small" or self-contained
T-libs
Relevant to the library team, which will review and decide on the PR/issue.
Location
All
wrapping_rem
methods.Summary
As reported in yoshuawuyts/futures-concurrency#156, when calling the
wrapping_rem
functions with a value of0
, a panic is triggered. The documentation of thewrapping_rem
method should include a# panic
section making note of this.Example
playground
The text was updated successfully, but these errors were encountered: