-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Closed
dotnet/dotnet-api-docs
#3334Labels
area-System.NumericsdocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codegood first issueIssue should be easy to implement, good for first-time contributorsIssue should be easy to implement, good for first-time contributorshelp wanted[up-for-grabs] Good issue for external contributors[up-for-grabs] Good issue for external contributors
Milestone
Description
This was raised in the dotnet/corefx gitter channel.
It is not currently clear from the documentation that the types exposed by the System.Numerics.Vectors
assembly are not meant for general purpose Vector
operations and that the types are heavily tied to the underlying hardware.
The documentation for this could be greatly improved.
Some types, such as Vector<T>
should have explicit (and readily visible) documentation that its element count is limited to Vector<T>.Count
, and that certain methods (such as the Vector(T[]) constructor) will only use the first Vector<T>.Count
elements and ignore the remaining.
AronParker, aliostad and lordcheeto
Metadata
Metadata
Assignees
Labels
area-System.NumericsdocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codegood first issueIssue should be easy to implement, good for first-time contributorsIssue should be easy to implement, good for first-time contributorshelp wanted[up-for-grabs] Good issue for external contributors[up-for-grabs] Good issue for external contributors