Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Comments for IMultiplyOperators`3 mention division. #80521

Closed
otac0n opened this issue Jan 11, 2023 · 7 comments · Fixed by #83693 or dotnet/dotnet-api-docs#8915
Closed

Documentation Comments for IMultiplyOperators`3 mention division. #80521

otac0n opened this issue Jan 11, 2023 · 7 comments · Fixed by #83693 or dotnet/dotnet-api-docs#8915
Labels
area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone
8.0.0

Comments

@otac0n
Copy link

otac0n commented Jan 11, 2023 •
edited
Loading

Description

The return value of both the checked and unchecked operators of the IMultiplyOperators`3 interface are documented as:

The product of <paramref name="left" /> divided-by <paramref name="right" />.

It should read

The product of <paramref name="left" /> multiplied-by <paramref name="right" />.

Reproduction Steps

None, this is a documentation issue.

Expected behavior

The return value should be documented as:

The product of <paramref name="left" /> multiplied-by <paramref name="right" />.

Actual behavior

The return value of both the checked and unchecked operators of the IMultiplyOperators`3 interface are documented as:

The product of <paramref name="left" /> divided-by <paramref name="right" />.

Regression?

No response

Known Workarounds

None.

Configuration

No response

Other information

No response
@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@ghost ghost added the untriaged New issue has not been triaged by the area owner label Jan 11, 2023
@vcsjones vcsjones added area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code labels Jan 11, 2023
@ghost
Copy link

ghost commented Jan 11, 2023

Tagging subscribers to this area: @dotnet/area-system-numerics
See info in area-owners.md if you want to be subscribed.

Issue Details

Description

The return value of both the checked and unchecked operators of the IMultiplyOperators`3 interface are documented as:

The product of <paramref name="left" /> divided-by <paramref name="right" />.

It should read

The product of <paramref name="left" /> multiplied-by <paramref name="right" />.

Reproduction Steps

None, this is a documentation issue.

Expected behavior

The return value should be documented as:

The product of <paramref name="left" /> multiplied-by <paramref name="right" />.

Actual behavior

The return value of both the checked and unchecked operators of the IMultiplyOperators`3 interface are documented as:

The product of <paramref name="left" /> divided-by <paramref name="right" />.

Regression?

No response

Known Workarounds

None.

Configuration

No response

Other information

No response

Author: otac0n
Assignees: -
Labels:

documentation, area-System.Numerics, untriaged
Milestone: -

@tannergooding tannergooding added help wanted [up-for-grabs] Good issue for external contributors and removed untriaged New issue has not been triaged by the area owner labels Jan 13, 2023
@tannergooding tannergooding added this to the 8.0.0 milestone Jan 13, 2023
@tannergooding
Copy link
Member

Marked this as up for grabs. Please feel free to submit a fix to both the XML comments in the runtime repo and to the corresponding docs page here: https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Numerics/IMultiplyOperators%603.xml

@IDisposable
Copy link
Contributor

Also fixed NFloat.cs (line 169) operator * comment

IDisposable added a commit to IDisposable/dotnet-runtime that referenced this issue Mar 20, 2023
@IDisposable
Correct doc comment for IMultiplyOperators returns
c895ea6 
Replaced _divided-by_ with _multiplied-by_ in both
IMultiplyOperators.cs and NFloat.cs.
Fixes dotnet#80521
@IDisposable IDisposable mentioned this issue Mar 20, 2023
Merged
@ghost ghost added the in-pr There is an active PR which will close this issue when it is merged label Mar 20, 2023
IDisposable added a commit to IDisposable/dotnet-api-docs that referenced this issue Mar 20, 2023
@IDisposable
Correct doc comment for IMultiplyOperators returns
00318d9 
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
@IDisposable IDisposable mentioned this issue Mar 20, 2023
Merged
@IDisposable
Copy link
Contributor

Added PRs for the source code fixed in runtime source and in the documentation

@IDisposable
Copy link
Contributor

I noticed while scanning the documentation that there's a WHOLE lot of stuff missing the content that should have been automatically pulled from the source documentation but currently reads To be added. Is there a plan in place to sync this stuff up via an automated tool, or would there be value in cleaning some of that up by hand?

AaronRobinsonMSFT pushed a commit to dotnet/dotnet-api-docs that referenced this issue Mar 20, 2023
@IDisposable
Correct doc comment for IMultiplyOperators returns (#8915)
fc9d254 
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
@IDisposable
Copy link
Contributor

Warning, the documentation push flagged this as closed but the PR for the /// comments has not yet been merged.

tannergooding pushed a commit that referenced this issue Mar 21, 2023
@IDisposable
Correct doc comment for IMultiplyOperators returns (#83693)
7b65174 
Replaced _divided-by_ with _multiplied-by_ in both
IMultiplyOperators.cs and NFloat.cs.
Fixes #80521
@ghost ghost removed the in-pr There is an active PR which will close this issue when it is merged label Mar 21, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Apr 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Milestone
8.0.0
4 participants
@otac0n @vcsjones @IDisposable @tannergooding