Skip to content

Clarify isqrt documentation for signed integers#154415

Open
JivinSardine wants to merge 1 commit intorust-lang:mainfrom
JivinSardine:fix/isqrt-doc-clarification
Open

Clarify isqrt documentation for signed integers#154415
JivinSardine wants to merge 1 commit intorust-lang:mainfrom
JivinSardine:fix/isqrt-doc-clarification

Conversation

@JivinSardine
Copy link

@JivinSardine JivinSardine commented Mar 26, 2026

Updates the doc comment for isqrt and checked_isqrt on signed integer types (i8, i16, i32, i64, i128) to clarify that the returned value is the non-negative (principal) square root.

Fixes #154000.

Updates the doc comment for isqrt and checked_isqrt on signed integer
types (i8, i16, i32, i64, i128) to clarify that the returned value is
the non-negative (principal) square root.

Fixes rust-lang#154000.
@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 Mar 26, 2026
@rustbot
Copy link
Collaborator

rustbot commented Mar 26, 2026

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: @scottmcm, libs
  • @scottmcm, libs expanded to 8 candidates
  • Random selection from Mark-Simulacrum, jhpratt, scottmcm

@rustbot
Copy link
Collaborator

rustbot commented Mar 26, 2026

⚠️ Warning ⚠️

  • There are issue links (such as #123) in the commit messages of the following commits.
    Please move them to the PR description, to avoid spamming the issues with references to the commit, and so this bot can automatically canonicalize them to avoid issues with subtree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(checked_)isqrt documentation for signed integers could clarify which root is returned

3 participants