Fix description of unsigned checked_exact_div
#144947
Open
+6
−12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
rustbot has assigned @Mark-Simulacrum. Use |
rustbot
added
S-waiting-on-review
tautschnig
force-pushed
the
remove-stray-checked_div-comment
branch
from
f244312 to
7e44d73
Compare
tautschnig
force-pushed
the
remove-stray-checked_div-comment
branch
from
7e44d73 to
651cd0f
Compare
xizheyin
reviewed
Aug 5, 2025
| /// | ||
| /// This function will panic if `rhs == 0` or `self % rhs != 0`. | ||
| /// Checked integer division without remainder. Computes `self / rhs`, | ||
| /// returning `None` if `rhs == 0` or if `self % rhs != 0`. |
There was a problem hiding this comment.
/// Returns `Some(self / rhs)` if `rhs` is not zero and `self` is evenly divisible by `rhs`.
/// Returns `None` otherwise.
A suggestion. We could mention both Some and None.
There was a problem hiding this comment.
We don't seem to do this in any of the other checked_... functions, so I'd rather not introduce this change for only one function.
There was a problem hiding this comment.
Yeah, following convention is better :) Perhaps a follow up could be considered like this...
Like its signed counterpart, this function does not panic. Also, fix the examples to document how it returns Some/None.
tautschnig
force-pushed
the
remove-stray-checked_div-comment
branch
from
651cd0f to
9c0cfd2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Like its signed counterpart, this function does not panic. Also, fix the examples to document how it returns Some/None.