Skip to content
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.

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

Missing period and colon in the description of methods for some primitive types #133018

Closed
sorairolake opened this issue Nov 14, 2024 · 2 comments · Fixed by #133019
Closed

Missing period and colon in the description of methods for some primitive types #133018

sorairolake opened this issue Nov 14, 2024 · 2 comments · Fixed by #133019
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@sorairolake
Copy link
Contributor

sorairolake commented Nov 14, 2024

Location

Methods for signed integer types which are missing a period:

Methods for unsigned integer types which are missing a period:

Methods for primitive types which are missing a colon:

Summary

I think the methods in the top two chunks above are missing a period at the end of the sentence.

For i32::unbounded_shl and u32::unbounded_shl:

-Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`
+Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`.

For i32::unbounded_shr and u32::unbounded_shr:

-Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`
+Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`.

For i32::overflowing_sub and u32::overflowing_sub:

-Calculates `self` - `rhs`
+Calculates `self` - `rhs`.

For i32::overflowing_sub_unsigned:

-Calculates `self` - `rhs` with an unsigned `rhs`
+Calculates `self` - `rhs` with an unsigned `rhs`.

Also, I think the methods in the last chunk are missing a colon in the examples section.

For u32::overflowing_add, u32::overflowing_sub, u32::overflowing_div, etc.:

-Basic usage
+Basic usage:
@sorairolake sorairolake added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Nov 14, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 14, 2024
@fmease fmease added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Nov 14, 2024
@sorairolake
Copy link
Contributor Author

@rustbot claim

@sorairolake sorairolake changed the title Missing period and colon in the description of methods for some primitive integer types Missing period and colon in the description of methods for some primitive types Nov 14, 2024
@sorairolake
Copy link
Contributor Author

str::parse is also missing a colon, so I'll fix this too.

@bors bors closed this as completed in a835f2a Nov 15, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Nov 15, 2024
Rollup merge of rust-lang#133019 - sorairolake:add-missing-period-and-colon, r=tgross35

docs: Fix missing period and colon in methods for primitive types

Closes rust-lang#133018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants