]> git.lizzy.rs Git - rust.git/commit - src/tools/miri
Auto merge of #82680 - jturner314:div_euclid-docs, r=JohnTitor
authorbors <bors@rust-lang.org>
Mon, 22 Mar 2021 09:37:50 +0000 (09:37 +0000)
committerbors <bors@rust-lang.org>
Mon, 22 Mar 2021 09:37:50 +0000 (09:37 +0000)
commit7f82ddb8750aef7c48173b84ec5a3d713edce263
tree5f0173ae93a1bafe489cfd306c9f3ebf3bf81e06
parent2b8fbe6b0b6db7960828bd2c9a50e52c9a5d0aef
parent77c0a48b7e19f1a8a8514ab48ffa7258a874ccb3
Auto merge of #82680 - jturner314:div_euclid-docs, r=JohnTitor

Fix inequality in docs for div_euclid

This commit fixes the statement of the inequality that the Euclidean remainder satisfies. (The remainder is guaranteed to be less than abs(rhs), not rhs.) It also rewords the documentation to make it a little easier to read.

(You might wonder why I've written `abs(rhs)` instead of `rhs.abs()`. Two reasons: first, the `rem_euclid` docs use `abs(rhs)` instead of `rhs.abs()`, and second, the absolute value here is the mathematical absolute value, not the the `.abs()` operation which may overflow.)