Skip to content

Explain what "normal" is in Double.IsNormal #12281

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

Open
sfiruch wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Explain what "normal" is in Double.IsNormal #12281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2947,7 +2947,7 @@ This method correctly handles floating-point values and so `2.0` and `3.0` will
</Parameters>
<Docs>
<param name="d">A double-precision floating-point number.</param>
<summary>Determines whether the specified value is normal.</summary>
<summary>Determines whether the specified value is not NaN, not infinite, not subnormal, and not zero.</summary>
Copy link
Member

@tannergooding tannergooding Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're wanting to not be repetitive, then repeating subnormal doesn't really help either.. The technical definition is:

Suggested change
<summary>Determines whether the specified value is not NaN, not infinite, not subnormal, and not zero.</summary>
<summary>Determines whether the specified value is a finite non-zero value with magnitude greater than or equal to <c>2<sup>-1022</sup></c>.</summary>

Copy link
Member

@tannergooding tannergooding Feb 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would expect Single, Half, NFloat, and INumberBase<TSelf> to all be updated in the same PR.

I would also expect other definitions like IsInfinite, IsSubnormal, IsFinite, etc to be updated if required.

Copy link
Member

@tannergooding tannergooding Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And as per the Copilot guidance below, the summary and remarks are effectively just mirroring eachother now, so the remarks need to either be removed or updated.

<returns>
<see langword="true" /> if the value is normal; <see langword="false" /> otherwise.</returns>
<remarks>This effectively checks the value is not NaN, not infinite, not subnormal, and not zero.</remarks>
Comment on lines 2952 to 2953
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated

explains what “normal” means, but the text still relies on the term “normal” without the definition. Consider updating to use the same explicit criteria (or add the definition there) so readers don’t have to infer it from the summary/remarks.

Also, the criteria list is now repeated in both

and , which creates duplication that can drift over time. Consider removing the redundant list from or using for additional context instead of repeating the same definition.

Suggested change
<see langword="true" /> if the value is normal; <see langword="false" /> otherwise.</returns>
<remarks>This effectively checks the value is not NaN, not infinite, not subnormal, and not zero.</remarks>
<see langword="true" /> if the value is not NaN, not infinite, not subnormal, and not zero; <see langword="false" /> otherwise.</returns>
<remarks>Use this method to determine whether a double-precision floating-point number is a normal value before performing calculations that assume finite, nonzero magnitudes.</remarks>

Copilot uses AI. Check for mistakes.
Expand Down
Loading