Skip to content

Explain what "normal" is in Single.IsNormal #12280

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 Single.IsNormal #12280

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/Single.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2958,7 +2958,7 @@ This method correctly handles floating-point values and so `2.0` and `3.0` will
</Parameters>
<Docs>
<param name="f">A single-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

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 summary now duplicates the remarks section verbatim. This creates unnecessary redundancy. The consistent pattern in Double.IsNormal (xml/System/Double.xml:2950) and Half.IsNormal (xml/System/Half.xml:2219) is to have a brief summary like "Determines whether the specified value is normal" and then provide the detailed explanation in the remarks section. Consider keeping the summary concise and letting the remarks section provide the detailed explanation of what "normal" means.

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 normal.</summary>

Copilot uses AI. Check for mistakes.
<returns>
<see langword="true" /> if <paramref name="f" /> is normal; <see langword="false" /> otherwise.</returns>
<remarks>This effectively checks the value is not NaN, not infinite, not subnormal, and not zero.</remarks>
Expand Down
Loading