Skip to content

Fix Vector documentation#74701

Merged
adamsitnik merged 1 commit intodotnet:mainfrom
MichalPetryka:patch-3
Oct 10, 2022
Merged

Fix Vector documentation#74701
adamsitnik merged 1 commit intodotnet:mainfrom
MichalPetryka:patch-3

Conversation

@MichalPetryka
Copy link
Contributor

The old docs used a wrong type, probably a leftover from being copied over.

For the webpage docs, see dotnet/dotnet-api-docs#8340

@ghost ghost added area-System.Numerics community-contribution Indicates that the PR has been added by a community member labels Aug 27, 2022
@ghost
Copy link

ghost commented Aug 27, 2022

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

Issue Details

The old docs used a wrong type, probably a leftover from being copied over.

For the webpage docs, see dotnet/dotnet-api-docs#8340

Author: MichalPetryka
Assignees: -
Labels:

area-System.Numerics

Milestone: -

/// <typeparam name="TTo">The type of the vector <paramref name="vector" /> should be reinterpreted as.</typeparam>
/// <param name="vector">The vector to reinterpret.</param>
/// <returns><paramref name="vector" /> reinterpreted as a new <see cref="Vector64{U}" />.</returns>
/// <returns><paramref name="vector" /> reinterpreted as a new <see cref="Vector{U}" />.</returns>
Copy link
Member

Choose a reason for hiding this comment

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

#75032 is renaming the T and U to be TFrom and TTo in similar docs. Presumably we should do so here as well.
cc: @gewarren

Copy link
Contributor

Choose a reason for hiding this comment

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

I see that the type param name used in a see cref doesn't actually affect how it's displayed in docs.microsoft.com - so perhaps the only reason to update it is when reading the source code.

Copy link
Member

@adamsitnik adamsitnik left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @MichalPetryka !

@adamsitnik adamsitnik merged commit c1fab9c into dotnet:main Oct 10, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Nov 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Numerics community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants