Skip to content

Commit 35033f8

Browse files
committed
Doc comment improvements
1 parent 604eef5 commit 35033f8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

BigReal/BigReal.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,44 +24,44 @@ namespace ExtendedNumerics;
2424
public readonly BigInteger Denominator;
2525

2626
/// <summary>
27-
/// A value representing the number 1.
27+
/// A value representing the number 1 (as 1/1).
2828
/// </summary>
2929
public static BigReal One { get; } = new(1);
3030
/// <summary>
31-
/// A value representing the number 10.
31+
/// A value representing the number 10 (as 10/1).
3232
/// </summary>
3333
public static BigReal Ten { get; } = new(10);
3434
/// <summary>
35-
/// A value representing the number 0.
35+
/// A value representing the number 0 (as 0/1).
3636
/// </summary>
3737
public static BigReal Zero { get; } = new(0);
3838
/// <summary>
39-
/// A value representing the number -1.
39+
/// A value representing the number -1 (as -1/1).
4040
/// </summary>
4141
public static BigReal NegativeOne { get; } = new(-1);
4242
/// <summary>
43-
/// A value representing the number 0.5.
43+
/// A value representing the number 0.5 (as 1/2).
4444
/// </summary>
4545
public static BigReal OneHalf { get; } = new(1, 2);
4646
/// <summary>
47-
/// A value representing a value that is not a number.
47+
/// A value representing a value that is not a number (as 0/0).
4848
/// </summary>
4949
public static BigReal NaN { get; } = new(0, 0);
5050
/// <summary>
51-
/// A value representing a value that is positive infinity.
51+
/// A value representing a value that is positive infinity (as 1/0).
5252
/// </summary>
5353
public static BigReal PositiveInfinity { get; } = new(1, 0);
5454
/// <summary>
55-
/// A value representing a value that is negative infinity.
55+
/// A value representing a value that is negative infinity (as -1/0).
5656
/// </summary>
5757
public static BigReal NegativeInfinity { get; } = new(-1, 0);
5858

5959
/// <summary>
60-
/// The number that, when added to a number, returns the other number.
60+
/// The number that, when added to a number, returns the other number. This number is 0.
6161
/// </summary>
6262
public static BigReal AdditiveIdentity => Zero;
6363
/// <summary>
64-
/// The number that, when multiplied by a number, returns the other number.
64+
/// The number that, when multiplied by a number, returns the other number. This number is 1.
6565
/// </summary>
6666
public static BigReal MultiplicativeIdentity => One;
6767

0 commit comments

Comments
 (0)