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

Add math.atan2 #819

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Add math.atan2 #819

merged 4 commits into from
Nov 18, 2024

Conversation

gordonbondon
Copy link
Contributor

No description provided.

@gordonbondon gordonbondon marked this pull request as draft November 14, 2024 17:56
stdlib/math.pkl Outdated
Comment on lines 148 to 150
/// Returns the [4-quadrant inverse tangent][1] of [x] and [y].
///
/// [1]: https://en.wikipedia.org/wiki/Atan2
Copy link
Contributor

@bioball bioball Nov 14, 2024

Choose a reason for hiding this comment

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

Since we're linking to Wikipedia, let's use verbiage that aligns with it.

Also, need a @Since annotation.

Suggested change
/// Returns the [4-quadrant inverse tangent][1] of [x] and [y].
///
/// [1]: https://en.wikipedia.org/wiki/Atan2
/// Returns the [2-argument arctangent][1] of [x] and [y].
///
/// [1]: https://en.wikipedia.org/wiki/Atan2
@Since { version = "0.28.0" }

It might also be helpful to have one more paragraph to describe this function's purpose. Maybe something like: "The result is 𝜃 (theta) when converting cartesian coordinates 𝑥 and 𝑦 to polar coordinates 𝑟 and 𝜃."

@gordonbondon gordonbondon marked this pull request as ready for review November 18, 2024 12:59
@holzensp
Copy link
Contributor

Needs a confirmation approval from @bioball (having requested changes); they look addressed to me.

Copy link
Contributor

@bioball bioball left a comment

Choose a reason for hiding this comment

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

LGTM!

@bioball bioball merged commit cc579f8 into apple:main Nov 18, 2024
4 checks passed
@bioball bioball added this to the Pkl 0.28.0 milestone Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants