Fix Hypot documentation typo: correct second parameter reference#124111
Open
Fix Hypot documentation typo: correct second parameter reference#124111
Conversation
Co-authored-by: vcsjones <361677+vcsjones@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix typo in TensorPrimitives.Hypot.cs documentation
Fix Hypot documentation typo: correct second parameter reference
Feb 6, 2026
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-numerics |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes an incorrect XML documentation example for TensorPrimitives.Hypot, aligning the <remarks> formula with the actual (x, y) method signature and behavior.
Changes:
- Corrected the
<paramref>reference in the<remarks>example fromxtoyfor the second argument toT.Hypot.
vcsjones
approved these changes
Feb 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The XML documentation for
TensorPrimitives.Hypotincorrectly stated the method computesT.Hypot(x[i], x[i])instead ofT.Hypot(x[i], y[i]).Changes
<paramref>in the<remarks>section fromxtoyon line 21 ofTensorPrimitives.Hypot.csThe method signature takes two parameters (
xandy), and the documentation now accurately reflects this.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.