Skip to content

Conversation

gewarren
Copy link
Contributor

No description provided.

@Copilot Copilot AI review requested due to automatic review settings May 14, 2025 03:52
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the XML documentation in Tensor.cs to fix punctuation issues and improve the accuracy of summary descriptions for tensor operations.

  • Removes extra periods in parameter descriptions.
  • Updates several summary texts for element-wise operations (e.g., MinMagnitude) to correctly denote the intended behavior.
  • Improves consistency in the documentation comments across tensor methods.
Comments suppressed due to low confidence (2)

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs:4457

  • The summary for the Min method is misleading; as a minimum operation it should state that it searches for the smallest number. Consider updating it to 'Searches for the smallest number in the specified tensor.'
/// <summary>Searches for the largest number in the specified tensor.</summary>

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs:4646

  • The summary for the MinNumber method is inaccurate for a minimum operation; it should indicate that it searches for the smallest number. Please update the text accordingly.
/// <summary>Searches for the largest number in the specified tensor.</summary>

Copy link
Contributor

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

@gewarren
Copy link
Contributor Author

@tannergooding I'm not sure if I'm safe to merge this using the escape hatch for build analysis. I looked at a few other PRs and they don't seem to have the same test failures, yet I'm pretty sure my failures aren't related to my changes.

@gewarren gewarren merged commit b13d90d into dotnet:main May 19, 2025
83 of 85 checks passed
@gewarren gewarren deleted the docs0513 branch May 19, 2025 20:46
@github-actions github-actions bot locked and limited conversation to collaborators Jun 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants