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.

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

TensorPrimitives XML docs: MinNumber/ReciprocalSqrt/ReciprocalSqrtEstimate oversights #109889

Merged
merged 2 commits into from
Nov 17, 2024

Conversation

delreluca
Copy link
Contributor

While going through the docs for TensorPrimitives I noticed some copy–paste accidents:

  1. MinNumber refers to maxima instead of minima
  2. ReciprocalSqrt and ReciprocalSqrtEstimate are missing the square root in the explanation of the effective computation

I cross-checked IEEE754:2019 to make sure that the now referenced minimumNumber exists.

Only XML doc comments are changed, no actual code.

delreluca and others added 2 commits November 16, 2024 17:39
They ware accidentally referring to maxima
The effective code was copied from the other reciprocal
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Nov 16, 2024
Copy link
Contributor

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

@delreluca
Copy link
Contributor Author

@dotnet-policy-service agree

Copy link
Member

@stephentoub stephentoub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@stephentoub
Copy link
Member

@jeffhandley, @gewarren, I believe for this library the XML comments are the source of truth. Do we still need to submit a PR separately to dotnet-api-docs? Do we backport this to release/9.0 and then the "right things" happen? Something else?

@stephentoub
Copy link
Member

/ba-g comment change only

@stephentoub stephentoub merged commit 96ae7cf into dotnet:main Nov 17, 2024
80 of 83 checks passed
@delreluca delreluca deleted the patch-1 branch November 17, 2024 15:27
@jeffhandley
Copy link
Member

@jeffhandley, @gewarren, I believe for this library the XML comments are the source of truth. Do we still need to submit a PR separately to dotnet-api-docs? Do we backport this to release/9.0 and then the "right things" happen? Something else?

Tagging @carlossanlop for the answer on this.

@carlossanlop
Copy link
Member

Do we still need to submit a PR separately to dotnet-api-docs?

Nope. Not if source of truth is triple slash comments as mentioned.

Do we backport this to release/9.0 and then the "right things" happen?

Yes. This needs to be backported to release/9.0-staging and the fixed docs should start showing up on the next servicing release.

@stephentoub
Copy link
Member

/backport to release/9.0-staging

Copy link
Contributor

Started backporting to release/9.0-staging: https://github.com/dotnet/runtime/actions/runs/11893607914

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Numerics 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.

4 participants