Update documentation for System.Numerics.Vector<T> to be more explicit.
#23283
Labels
area-System.Numerics
documentation
Documentation bug or enhancement, does not impact product or test code
good first issue
Issue should be easy to implement, good for first-time contributors
help wanted
[up-for-grabs] Good issue for external contributors
Milestone
Comments
|
Thank you! |
|
I think this issue probably should be in https://github.com/dotnet/docs. |
|
We need to propose wording changes in docs, then move it to docs repo. |
|
Opened a fix PR that (hopefully) points these out in dotnet/dotnet-api-docs repo. |
carlossanlop
referenced
this issue
in dotnet/dotnet-api-docs
Jan 6, 2020
* Update System.Numerics.Vector documents * Emphasise that this type is not appropriate for general purpose vector operations * Update ctor remarks so that only primitive numeric types are allowed * Update ctor remarks so that only the first `Vector<T>.Count` elements are added to the vector (for Span/Array overloads) * Add information about exception that can be thrown when array.Length < Vector<T>.Count Related: https://github.com/dotnet/corefx/issues/23448 * Apply suggestions * Pull the type constraint to the top of the ctor docs since it's shared throughout, list out the types for future-proofing * Update param descriptions for array/spans to be explicit about the remainders Part of dotnet-api-docs/#3334 Co-Authored-By: Tanner Gooding <tagoo@outlook.com> * Use see tag * Reference the type instead of just writing it out * Define the meaning of primitive numeric data type * Pluralise "instance" Co-authored-by: Tanner Gooding <tagoo@outlook.com>
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.Vectorsassembly are not meant for general purposeVectoroperations 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 toVector<T>.Count, and that certain methods (such as the Vector(T[]) constructor) will only use the firstVector<T>.Countelements and ignore the remaining.The text was updated successfully, but these errors were encountered: