dotnet-api-docs icon indicating copy to clipboard operation
dotnet-api-docs copied to clipboard

Vector2.Reflect : Missing: Normal must be normalized

Open ThomasUttendorfer opened this issue 11 months ago • 1 comments

Type of issue

Typo

Description

The documentation for Vector2.Reflect mentions using a normal vector, but it doesn’t explicitly state that the normal vector should be normalized. This can lead to confusion, as the reflection calculation assumes a normalized normal vector. Otherwise Reflect creates a wrong result.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.numerics.vector2.reflect?view=net-9.0

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Numerics/Vector2.xml

Document Version Independent Id

43d18e54-0787-7c38-4591-b76f28408224

Article author

@dotnet-bot

ThomasUttendorfer avatar Jan 16 '25 13:01 ThomasUttendorfer

I'm honestly more inclined into changing docs to state "unit normal vector". This is an extra operation which might matter in some cases.

EDIT: I just realized this is in the docs repo rather than runtime, I thought you were requesting we do the normalization 😄

krwq avatar Jan 16 '25 14:01 krwq