doc: rewrite doc for uint::{carrying_add,borrowing_sub} #101889
Merged
Conversation
This file contains 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
|
Hey! It looks like you've submitted a new PR for the library teams! If this PR contains changes to any Examples of
|
rustbot
added
the
T-libs
|
(rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
r? @m-ou-se |
|
If this is accepted, I can also have a go at the documentation for the signed methods. |
This comment has been minimized.
This comment has been minimized.
tspiteri
force-pushed
the
redoc-uint-adc-sbb
branch
from
1d22c1d
to
f4d4088
Compare
tspiteri
force-pushed
the
redoc-uint-adc-sbb
branch
from
f4d4088
to
33421da
Compare
|
Thanks! @bors r+ rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Oct 18, 2022
…u-se
doc: rewrite doc for uint::{carrying_add,borrowing_sub}
Reword the documentation for bigint helper methods `uint::{carrying_add,borrowing_sub}` (rust-lang#85532).
The examples were also rewritten to demonstrate how the methods can be used in bignum arithmetic. No loops are used in the examples, but the variable names were chosen to include indices so that it is clear how this can be used in a loop if required.
Also, previously `carrying_add` had an example to say that if the input carry is false, the method is equivalent to `overflowing_add`. While the note was kept, the example was removed and an extra note was added to make sure this equivalence is not assumed for signed integers as well.
This was referenced Oct 18, 2022
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 19, 2022
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#101889 (doc: rewrite doc for uint::{carrying_add,borrowing_sub}) - rust-lang#102507 (More slice::partition_point examples) - rust-lang#103164 (rustdoc: remove CSS ``@media` (min-width: 701px)`) - rust-lang#103189 (Clean up code-color and headers-color rustdoc GUI tests) - rust-lang#103203 (Retrieve LLVM version from llvm-filecheck binary if it is not set yet) - rust-lang#103204 (Add some more autolabels) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jan 12, 2023
doc: rewrite doc for signed int::{carrying_add,borrowing_sub}
Reword the documentation for bigint helper methods, signed `int::{carrying_add,borrowing_sub}` (rust-lang#85532).
This change is a follow-up to rust-lang#101889, which was for the unsigned methods.
compiler-errors
added a commit
to compiler-errors/rust
that referenced
this pull request
Jan 12, 2023
doc: rewrite doc for signed int::{carrying_add,borrowing_sub}
Reword the documentation for bigint helper methods, signed `int::{carrying_add,borrowing_sub}` (rust-lang#85532).
This change is a follow-up to rust-lang#101889, which was for the unsigned methods.
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.
Reword the documentation for bigint helper methods
uint::{carrying_add,borrowing_sub}(#85532).The examples were also rewritten to demonstrate how the methods can be used in bignum arithmetic. No loops are used in the examples, but the variable names were chosen to include indices so that it is clear how this can be used in a loop if required.
Also, previously
carrying_addhad an example to say that if the input carry is false, the method is equivalent tooverflowing_add. While the note was kept, the example was removed and an extra note was added to make sure this equivalence is not assumed for signed integers as well.