Skip to content

Commit

Permalink
Correct doc comment for IMultiplyOperators returns (#8915)
Browse files Browse the repository at this point in the history
Replaced _divided-by_ with _multiplied-by_ in
System.Half, System.Int128, System.UInt128,
System.Numerics.IMultiplyOperators, and
System.Runtime.InteropServices.NFloat.
This reflects the matching changes in
dotnet/runtime#83693 to the
IMultiplyOperators and NFloat and
fixes dotnet/runtime#80521
  • Loading branch information
IDisposable authored Mar 20, 2023
1 parent 71024a8 commit fc9d254
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion xml/System.Numerics/IMultiplyOperators`3.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<param name="left">The value which <paramref name="right" /> multiplies.</param>
<param name="right">The value which multiplies <paramref name="left" />.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<exception cref="T:System.OverflowException">The product of <paramref name="left" /> multiplied by <paramref name="right" /> is not representable by <typeparamref name="TResult" />.</exception>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Runtime.InteropServices/NFloat.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4290,7 +4290,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<param name="left">The value that <paramref name="right" /> multiplies.</param>
<param name="right">The value that multiplies <paramref name="left" />.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System/Half.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4252,7 +4252,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/System/Int128.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1491,7 +1491,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
</Docs>
Expand Down Expand Up @@ -2847,7 +2847,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/System/UInt128.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1383,7 +1383,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
</Docs>
Expand Down Expand Up @@ -2739,7 +2739,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>Multiplies two values together to compute their product.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
</Docs>
Expand Down

0 comments on commit fc9d254

Please sign in to comment.