Update remarks for IsRealNumber

FilipToth · Oct 17, 2024 · b6f5ac2 · b6f5ac2
1 parent bf23102
commit b6f5ac2
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/libraries/System.Private.CoreLib/src/System/Numerics/INumberBase.cs b/src/libraries/System.Private.CoreLib/src/System/Numerics/INumberBase.cs
@@ -216,7 +216,10 @@ static virtual TSelf CreateTruncating<TOther>(TOther value)
         /// <summary>Determines if a value represents a real value.</summary>
         /// <param name="value">The value to be checked.</param>
         /// <returns><c>true</c> if <paramref name="value" /> is a real number; otherwise, <c>false</c>.</returns>
-        /// <remarks>This function returns <c>true</c> for a complex number <c>a + bi</c> where <c>b</c> is zero.</remarks>
+        /// <remarks>
+        ///     <para>This function returns <c>true</c> for a complex number <c>a + bi</c> where <c>b</c> is zero.</para>
+        ///     <para>This function checks values against the extended real number line, thus returns <c>true</c> for positive and negative infinity.</para>
+        /// </remarks>
         static abstract bool IsRealNumber(TSelf value);
 
         /// <summary>Determines if a value is subnormal.</summary>