[SPARK-46767][PYTHON][DOCS] Refine docstring of abs/acos/acosh
#44794
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
| +------------------+ | ||
| | ACOS(value)| | ||
| +------------------+ | ||
| |1.0471975511965979| |
There was a problem hiding this comment.
for trigonometric functions' example, what about making them use or return some special values? e.g.
In [26]: df = spark.createDataFrame([(-1.0, 0.5), (-0.5, -0.5), (0.0, 1.0), (0.5, 0.0), (1.0, 1.0)], ["v1", "v2"])
In [27]: df.select("v1", sf.acos("v1"), sf.degrees(sf.acos("v1"))).show()
+----+------------------+------------------+
| v1| ACOS(v1)| DEGREES(ACOS(v1))|
+----+------------------+------------------+
|-1.0| 3.141592653589...| 180.0|
|-0.5|2.0943951023931...|120.00000000000...|
| 0.0|1.5707963267948...| 90.0|
| 0.5|1.0471975511965...| 60.00000000000...|
| 1.0| 0.0| 0.0|
+----+------------------+------------------+
and we'd better use ... at the last of numbers, since the computation result may vary slightly on different envs.
| >>> df = spark.createDataFrame([(-1.0,), (-0.5,), (0.0,), (0.5,), (1.0,)], ["value"]) | ||
| >>> df.select("value", | ||
| ... sf.substring(sf.acos("value"), 0, 15).alias("ACOS(value)"), | ||
| ... sf.substring(sf.degrees(sf.acos("value")), 0, 5).alias("DEGREES(ACOS(value))") |
There was a problem hiding this comment.
thanks, this looks pretty good.
btw, I guess we can use sf.round to make the result more stable.
There was a problem hiding this comment.
or let's simply remove the degrees column
| +-----+---------------+--------------------+ | ||
| | -1.0|3.1415926535897| 180.0| | ||
| | -0.5|2.0943951023931| 120.0| | ||
| | 0.0|1.5707963267948| 90.0| |
There was a problem hiding this comment.
Suggested change
| | 0.0|1.5707963267948| 90.0| | |
| | 0.0|1.5707963267...| 90.0| |
and other similar places.
To make the result more stable: e.g. the doctest won't fail when we change jdk version/python version/underlying engineer/etc.
zhengruifeng
approved these changes
Jan 19, 2024
|
Merged into master. Thanks @zhengruifeng |
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.
What changes were proposed in this pull request?
This pr refine docstring of
abs/acos/acoshand add some new examples.Why are the changes needed?
To improve PySpark documentation
Does this PR introduce any user-facing change?
No
How was this patch tested?
Pass Github Actions
Was this patch authored or co-authored using generative AI tooling?
No