Skip to content

Add docs remarks for IsRealNumber handling of infinities #10565

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

Merged
merged 3 commits into from
Oct 16, 2024
Merged

Add docs remarks for IsRealNumber handling of infinities #10565

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02640d9
Add docs remarks for IsRealNumber handling of infinities
FilipToth Oct 15, 2024
e07db1b
Fix xref and clarify edge case in Complex
FilipToth Oct 15, 2024
de098e3
Reword IsRealNumber docs for better clarity
FilipToth Oct 16, 2024
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: 2 additions & 0 deletions xml/System.Numerics/Complex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2292,6 +2292,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for a complex number `a + bi` where `a` is infinity, but not `b`, and does not return true for <xref:System.Numerics.Complex.Infinity>.

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Numerics/INumberBase`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for positive and negative infinity.

]]></format>
</remarks>
</Docs>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Runtime.InteropServices/NFloat.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2414,6 +2414,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for <xref:System.Runtime.InteropServices.NFloat.PositiveInfinity> and <xref:System.Runtime.InteropServices.NFloat.NegativeInfinity>.

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />
Expand Down
2 changes: 2 additions & 0 deletions xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3154,6 +3154,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for <xref:System.Double.PositiveInfinity> and <xref:System.Double.NegativeInfinity>.

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />
Expand Down
2 changes: 2 additions & 0 deletions xml/System/Half.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2360,6 +2360,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for <xref:System.Half.PositiveInfinity> and <xref:System.Half.NegativeInfinity>.

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />
Expand Down
2 changes: 2 additions & 0 deletions xml/System/Single.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3171,6 +3171,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%

This function returns `true` for a complex number `a + bi` where `b` is zero.

This function also returns `true` for <xref:System.Single.PositiveInfinity> and <xref:System.Single.NegativeInfinity>.

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />
Expand Down