Skip to content

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

Closed
@sorairolake

Description

@sorairolake

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:

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-libsRelevant to the library team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions