Improve the definition of atan2() #60493
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
typescript-bot
added
the
For Uncommitted Bug
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
j4k0xb
reviewed
Nov 13, 2024
| @@ -678,7 +678,7 @@ interface Math { | |||
| */ | |||
| atan(x: number): number; | |||
| /** | |||
| * Returns the angle (in radians) from the X axis to a point. | |||
| * Returns the angle (in radians) between the X axis and a line going through the given point. | |||
There was a problem hiding this comment.
"a line" could be anything.
I suggest changing it to be like your PR description or https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atan2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves the description for atan2, as the angle isn't really from the x axis to a point (that doesn't make any sense), it's the angle of a line from the origin to that point.
I hope this new description better conveys that.