Skip to content

Commit fc9d254

Browse files
authored
Correct doc comment for IMultiplyOperators returns (#8915)
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
1 parent 71024a8 commit fc9d254

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

xml/System.Numerics/IMultiplyOperators`3.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<param name="left">The value which <paramref name="right" /> multiplies.</param>
5353
<param name="right">The value which multiplies <paramref name="left" />.</param>
5454
<summary>Multiplies two values together to compute their product.</summary>
55-
<returns>The product of <paramref name="left" /> divided by <paramref name="right" />.</returns>
55+
<returns>The product of <paramref name="left" /> multiplied by <paramref name="right" />.</returns>
5656
<remarks>To be added.</remarks>
5757
<exception cref="T:System.OverflowException">The product of <paramref name="left" /> multiplied by <paramref name="right" /> is not representable by <typeparamref name="TResult" />.</exception>
5858
</Docs>

xml/System.Runtime.InteropServices/NFloat.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4290,7 +4290,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
42904290
<param name="left">The value that <paramref name="right" /> multiplies.</param>
42914291
<param name="right">The value that multiplies <paramref name="left" />.</param>
42924292
<summary>Multiplies two values together to compute their product.</summary>
4293-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
4293+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
42944294
<remarks>To be added.</remarks>
42954295
</Docs>
42964296
</Member>

xml/System/Half.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4252,7 +4252,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
42524252
<param name="left">To be added.</param>
42534253
<param name="right">To be added.</param>
42544254
<summary>Multiplies two values together to compute their product.</summary>
4255-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
4255+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
42564256
<remarks>To be added.</remarks>
42574257
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
42584258
</Docs>

xml/System/Int128.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1491,7 +1491,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
14911491
<param name="left">To be added.</param>
14921492
<param name="right">To be added.</param>
14931493
<summary>Multiplies two values together to compute their product.</summary>
1494-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
1494+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
14951495
<remarks>To be added.</remarks>
14961496
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
14971497
</Docs>
@@ -2847,7 +2847,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
28472847
<param name="left">To be added.</param>
28482848
<param name="right">To be added.</param>
28492849
<summary>Multiplies two values together to compute their product.</summary>
2850-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
2850+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
28512851
<remarks>To be added.</remarks>
28522852
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
28532853
</Docs>

xml/System/UInt128.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1383,7 +1383,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
13831383
<param name="left">To be added.</param>
13841384
<param name="right">To be added.</param>
13851385
<summary>Multiplies two values together to compute their product.</summary>
1386-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
1386+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
13871387
<remarks>To be added.</remarks>
13881388
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
13891389
</Docs>
@@ -2739,7 +2739,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
27392739
<param name="left">To be added.</param>
27402740
<param name="right">To be added.</param>
27412741
<summary>Multiplies two values together to compute their product.</summary>
2742-
<returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
2742+
<returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
27432743
<remarks>To be added.</remarks>
27442744
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
27452745
</Docs>

0 commit comments

Comments
 (0)