Skip to content

Commit 02640d9

Browse files
committed
Add docs remarks for IsRealNumber handling of infinities
1 parent 77ee1b1 commit 02640d9

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

xml/System.Numerics/Complex.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2292,6 +2292,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
22922292
22932293
This function returns `true` for a complex number `a + bi` where `b` is zero.
22942294
2295+
This function also returns `true` for <xref:System.Numerics.Infinity> and a complex number `a + bi` where `a` is infinity, but not `b`.
2296+
22952297
]]></format>
22962298
</remarks>
22972299
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

xml/System.Numerics/INumberBase`1.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -782,6 +782,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
782782
783783
This function returns `true` for a complex number `a + bi` where `b` is zero.
784784
785+
This function also returns `true` for positive and negative infinity.
786+
785787
]]></format>
786788
</remarks>
787789
</Docs>

xml/System.Runtime.InteropServices/NFloat.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2414,6 +2414,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
24142414

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

2417+
This function also returns `true` for <xref:System.Runtime.InteropServices.NFloat.PositiveInfinity> and <xref:System.Runtime.InteropServices.NFloat.NegativeInfinity>.
2418+
24172419
]]></format>
24182420
</remarks>
24192421
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

xml/System/Double.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3154,6 +3154,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
31543154

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

3157+
This function also returns `true` for <xref:System.Double.PositiveInfinity> and <xref:System.Double.NegativeInfinity>.
3158+
31573159
]]></format>
31583160
</remarks>
31593161
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

xml/System/Half.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2360,6 +2360,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
23602360
23612361
This function returns `true` for a complex number `a + bi` where `b` is zero.
23622362
2363+
This function also returns `true` for <xref:System.Half.PositiveInfinity> and <xref:System.Half.NegativeInfinity>.
2364+
23632365
]]></format>
23642366
</remarks>
23652367
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

xml/System/Single.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3171,6 +3171,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
31713171

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

3174+
This function also returns `true` for <xref:System.Single.PositiveInfinity> and <xref:System.Single.NegativeInfinity>.
3175+
31743176
]]></format>
31753177
</remarks>
31763178
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

0 commit comments

Comments
 (0)