Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vector2.Reflect : Missing: Normal must be normalized #10844

Open
ThomasUttendorfer opened this issue Jan 16, 2025 · 1 comment
Open

Vector2.Reflect : Missing: Normal must be normalized #10844

ThomasUttendorfer opened this issue Jan 16, 2025 · 1 comment
Labels
area-System.Numerics untriaged New issue has not been triaged by the area owner

Comments

@ThomasUttendorfer
Copy link

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

@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Jan 16, 2025
@krwq
Copy link
Member

krwq commented Jan 16, 2025

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 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Numerics untriaged New issue has not been triaged by the area owner
Projects
None yet
Development

No branches or pull requests

2 participants