docs: Fix docstrings for ATAN2 and ATAN2D SQL functions #19351
Merged
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.
The docs for
ATAN2
andATAN2D
(SQL functions) were incorrect because they claimed to be dividingarg2/arg1
where it is actually the other way around.Alternatively, one could swap the arguments in the implementation, but I like the implementation and it follows
numpy
.Also, I changed the example in the docstring so that it uses lengths of 0, 1, or 2, and not the ambiguous "lengths" of 90, 360 etc.