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

[release/9.0-staging] TensorPrimitives XML docs: MinNumber/ReciprocalSqrt/ReciprocalSqrtEstimate oversights #109922

Merged

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Nov 18, 2024

Backport of #109889 to release/9.0-staging

/cc @stephentoub @delreluca

Customer Impact

  • Customer reported
  • Found internally

A customer found and fixed these API docs issues:

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

Because XML doc comments are the source of truth for these APIs, updating the comments will result in the docs being corrected after the next servicing release.

Regression

  • Yes
  • No

Testing

n/a

Risk

Low. Docs / XML comments-only change.

delreluca and others added 2 commits November 18, 2024 13:38
They ware accidentally referring to maxima
The effective code was copied from the other reciprocal
Copy link
Contributor

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

@stephentoub stephentoub added this to the 9.0.x milestone Nov 18, 2024
@stephentoub stephentoub added the Servicing-consider Issue for next servicing release review label Nov 18, 2024
@stephentoub
Copy link
Member

cc: @jeffhandley

Copy link
Member

@jeffhandley jeffhandley left a comment

Choose a reason for hiding this comment

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

FYI @artl93

@jeffhandley jeffhandley added Servicing-approved Approved for servicing release and removed Servicing-consider Issue for next servicing release review labels Nov 25, 2024
@jeffhandley
Copy link
Member

/ba-g Failures are known and unrelated

@jeffhandley jeffhandley merged commit 9701fe0 into release/9.0-staging Nov 25, 2024
83 of 90 checks passed
@jeffhandley jeffhandley deleted the backport/pr-109889-to-release/9.0-staging branch November 25, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Numerics Servicing-approved Approved for servicing release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants