Skip to content

Conversation

@IDisposable
Copy link
Contributor

Summary

The copy-pasted and inherited documentation for the multiplication operation was incorrect. There were several instances of either divided-by or divided by that should have been multiplied-by or multiplied by (respectively).

Replaced text in XML documentation for System.Half, System.Int128, System.UInt128, System.Numerics.IMultiplyOperators, and System.Runtime.InteropServices.NFloat.

This reflects the matching changes in runtime PR dotnet/runtime#83693 to the IMultiplyOperators.cs and NFloat.cs.

Fixes dotnet/runtime#80521

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 Author

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?

@learn-build-service-prod
Copy link

Learn Build status updates of commit 00318d9:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Numerics/IMultiplyOperators`3.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View
xml/System/Half.xml ✅Succeeded View
xml/System/Int128.xml ✅Succeeded View
xml/System/UInt128.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites.

For any questions, please:

@AaronRobinsonMSFT AaronRobinsonMSFT merged commit fc9d254 into dotnet:main Mar 20, 2023
@IDisposable IDisposable deleted the fix-multiply-doc branch March 20, 2023 21:49
@IDisposable
Copy link
Contributor Author

IDisposable commented Mar 20, 2023

Thanks for merging! @AaronRobinsonMSFT, any comment about #8915 (comment)

@AaronRobinsonMSFT
Copy link
Member

Thanks for merging! @AaronRobinsonMSFT, any comment about #8915 (comment)

Oops. Very sorry to have missed that. Yes, there was tooling, unsure if it still exists. @carlossanlop used to be the contact for that. Nowadays we get sync PRs that attempt to synchronize then. Unsure if they are still active.

@IDisposable
Copy link
Contributor Author

Maybe I'll do a sweep then ;)

@carlossanlop
Copy link
Contributor

Thanks for your contribution, @IDisposable . Note that dotnet-api-docs is considered our source of truth for documentation, not triple slash. It currently depends on area owners if they want to keep the docs synced in both places, but the default behavior is to have the correct documentation here.

If you'd like to continue contributing with similar changes, my suggestion is that you only do it here, so you don't work double.

We will eventually convert runtime triple slash into the source of truth (after we make the correct adaptations in our infra) and contributors won't have to do what you did of correcting both places.

Regarding your question: we run a tool during Preview7 and RC1 to sync the two repos, to ensure we ship the new .NET version with the latest docs. Do you know when these APIs were introduced to source? If they were introduced in .NET 7, then the tool might have a bug that prevented them from getting ported from triple slash and into dotnet-api-docs. But if they were recently introduced in .NET 8, then it's expected that the dotnet-api-docs docs are empty, we will port everything in Preview7, and my recommendation is that you don't do all this manual work yet. We will eventually get it all ported.

@IDisposable
Copy link
Contributor Author

IDisposable commented Mar 20, 2023

Maybe I won't do a sweep then ;)

As to the specific change, I literally just picked up the first easy "help wanted" that I saw and started down the merry path.

The PR that added this incorrect /// comment was dotnet/runtime#54650 and was merged July 2, 2021.
https://github.com/dotnet/runtime/pull/54650/files#diff-5bef0c49804fbe50148c64a5d94d9aab05e8fd3ea4929080c1b97d7cb6b24b5bR23

Looks like the NFloat one happened in here dotnet/runtime#64234 on Jan 28, 2022.
https://github.com/dotnet/runtime/pull/64234/files#diff-9595a4ef5babfa1328d89e6481dbb32b0e9af358f460dddf2e90d588e2fe3dbbR154

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-System.Runtime community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Comments for IMultiplyOperators`3 mention division.

3 participants