Skip to content

Correct types in method descriptions of NonZero* types #112644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 17, 2023
Merged

Correct types in method descriptions of NonZero* types #112644

merged 1 commit into from
Jun 17, 2023

Conversation

@zica87
Copy link
Contributor

@zica87 zica87 commented Jun 15, 2023

  • $Int: e.g. i32, usize
  • $Ty: e.g. NonZeroI32, NonZeroUsize
method current description after my changes
saturating_add ...Return $Int::MAX on overflow. ...Return $Ty::MAX on overflow.
checked_abs ...returns None if self == $Int::MIN. ...returns None if self == $Ty::MIN.
checked_neg ...returning None if self == i32::MIN. ...returning None if self == $Ty::MIN.
saturating_neg ...returning MAX if self == i32::MIN... ...returning $Ty::MAX if self == $Ty::MIN...
saturating_mul ...Return $Int::MAX... ...Return $Ty::MAX...
saturating_pow ...Return $Int::MIN or $Int::MAX... ...Return $Ty::MIN or $Ty::MAX...

For example:

pub const fn saturating_neg(self) -> NonZeroI128
  • current
    • Saturating negation. Computes -self, returning MAX if self == i32::MIN instead of overflowing.
  • after my changes
    • Saturating negation. Computes -self, returning NonZeroI128::MAX if self == NonZeroI128::MIN instead of overflowing.

@rustbot
Copy link
Collaborator

rustbot commented Jun 15, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jun 15, 2023
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jun 17, 2023

📌 Commit 88b0858 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 17, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 17, 2023
@matthiaskrgr
Rollup merge of rust-lang#112644 - zica87:nonZeroTypes, r=Mark-Simula…
22d1e66 
…crum

Correct types in method descriptions of `NonZero*` types

- `$Int`: e.g. i32, usize
- `$Ty`: e.g. NonZeroI32, NonZeroUsize

|method|current description|after my changes|
|-|-|-|
|`saturating_add`|...Return `$Int`::MAX on overflow.|...Return `$Ty`::MAX on overflow.|
|`checked_abs`|...returns None if self == `$Int`::MIN.|...returns None if self == `$Ty`::MIN.|
|`checked_neg`|...returning None if self == i32::MIN.|...returning None if self == `$Ty`::MIN.|
|`saturating_neg`|...returning MAX if self == i32::MIN...|...returning `$Ty`::MAX if self == `$Ty`::MIN...|
|`saturating_mul`|...Return `$Int`::MAX...|...Return `$Ty`::MAX...|
|`saturating_pow`|...Return `$Int`::MIN or `$Int`::MAX...|...Return `$Ty`::MIN or `$Ty`::MAX...|

---

For example:

```rust
pub const fn saturating_neg(self) -> NonZeroI128
```

- current
  - Saturating negation. Computes `-self`, returning `MAX` if `self == i32::MIN` instead of overflowing.
- after my changes
  - Saturating negation. Computes `-self`, returning `NonZeroI128::MAX` if `self == NonZeroI128::MIN` instead of overflowing.
@matthiaskrgr matthiaskrgr mentioned this pull request Jun 17, 2023
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request Jun 17, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 17, 2023
@bors
Auto merge of rust-lang#112739 - matthiaskrgr:rollup-8cfggml, r=matth…
e1c29d1 
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#112352 (Fix documentation build on FreeBSD)
 - rust-lang#112644 (Correct types in method descriptions of `NonZero*` types)
 - rust-lang#112683 (fix ICE on specific malformed asm clobber_abi)
 - rust-lang#112707 ([rustdoc] Fix invalid handling of "going back in history" when "go to only search result" setting is enabled)
 - rust-lang#112719 (Replace fvdl with ffx, allow test without install)
 - rust-lang#112728 (Add `<meta charset="utf-8">` to `-Zdump-mir-spanview` output)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit ba3e535 into rust-lang:master Jun 17, 2023
@rustbot rustbot added this to the 1.72.0 milestone Jun 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@Mark-Simulacrum Mark-Simulacrum

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.72.0

Development

Successfully merging this pull request may close these issues.

4 participants

@zica87 @rustbot @Mark-Simulacrum @bors