Skip to content

Update documentation for System.Numerics.Vector<T> to be more explicit. #23283

@tannergooding

Description

@tannergooding

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-System.NumericsdocumentationDocumentation bug or enhancement, does not impact product or test codegood first issueIssue should be easy to implement, good for first-time contributorshelp wanted[up-for-grabs] Good issue for external contributors

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions