Skip to content

Commit

Permalink
Correct doc comment for IMultiplyOperators returns (#83693)
Browse files Browse the repository at this point in the history
Replaced _divided-by_ with _multiplied-by_ in both
IMultiplyOperators.cs and NFloat.cs.
Fixes #80521
  • Loading branch information
IDisposable committed Mar 21, 2023
1 parent 12e9711 commit 7b65174
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ public interface IMultiplyOperators<TSelf, TOther, TResult>
/// <summary>Multiplies two values together to compute their product.</summary>
/// <param name="left">The value which <paramref name="right" /> multiplies.</param>
/// <param name="right">The value which multiplies <paramref name="left" />.</param>
/// <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
/// <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
static abstract TResult operator *(TSelf left, TOther right);

/// <summary>Multiplies two values together to compute their product.</summary>
/// <param name="left">The value which <paramref name="right" /> multiplies.</param>
/// <param name="right">The value which multiplies <paramref name="left" />.</param>
/// <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
/// <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
/// <exception cref="OverflowException">The product of <paramref name="left" /> multiplied-by <paramref name="right" /> is not representable by <typeparamref name="TResult" />.</exception>
static virtual TResult operator checked *(TSelf left, TOther right) => left * right;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ public double Value
/// <summary>Multiplies two values together to compute their product.</summary>
/// <param name="left">The value which <paramref name="right" /> multiplies.</param>
/// <param name="right">The value which multiplies <paramref name="left" />.</param>
/// <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
/// <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
[NonVersionable]
public static NFloat operator *(NFloat left, NFloat right) => new NFloat(left._value * right._value);

Expand Down

0 comments on commit 7b65174

Please sign in to comment.