Added all missing xml docs for Tensors #106084
Merged
Conversation
This file contains 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
|
Tagging subscribers to this area: @dotnet/area-system-numerics-tensors |
michaelgsharp
requested review from
carlossanlop,
stephentoub,
eiriktsarpalis,
ericstj,
tannergooding and
gewarren
|
@gewarren could you review the language for these new docs? We will also need to review the language for the other APIs not being added in this PR, but I'll do another pass on those before I have you take a look. |
gewarren
reviewed
Aug 7, 2024
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.Factory.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/TensorExtensions.cs
Outdated
Show resolved
Hide resolved
| /// <param name="shape1">The first shape to broadcast.</param> | ||
| /// <param name="shape2">The second shape to broadcast.</param> | ||
| /// <returns>The smallest lengths these shapes can be broadcast to.</returns> | ||
| /// <exception cref="ArgumentException"></exception> |
There was a problem hiding this comment.
Suggested change
| /// <exception cref="ArgumentException"></exception> | |
| /// <exception cref="ArgumentException">The lengths of <paramref name="shape1" /> and <paramref name="shape2" /> are not broadcast compatible.</exception> |
This was referenced Aug 7, 2024
This was referenced Aug 9, 2024
ViktorHofer
reviewed
Aug 11, 2024
src/libraries/System.Numerics.Tensors/src/System.Numerics.Tensors.csproj
Show resolved
Hide resolved
|
@michaelgsharp I resolved your merge conflicts from #106179 |
|
@gewarren all comments have been resolved. |
gewarren
approved these changes
Aug 12, 2024
carlossanlop
approved these changes
Aug 12, 2024
This was referenced Aug 12, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds as missing XML docs for all public APIs.
It also enables
UseCompilerGeneratedDocXmlFileso that we can use these as the source of truth. We will need to review the XML that was already in the repo and not being modified by this PR. That will be done in a separate PR so this is not held by that.