[SPARK-54986][PYSPARK][DOCS] Document return type (DoubleType) for aggregate functions#55075
Open
hudda-ravina wants to merge 1 commit intoapache:masterfrom
Open
[SPARK-54986][PYSPARK][DOCS] Document return type (DoubleType) for aggregate functions#55075hudda-ravina wants to merge 1 commit intoapache:masterfrom
hudda-ravina wants to merge 1 commit intoapache:masterfrom
Conversation
…PySpark Signed-off-by: Ravina Hudda <huddaravina236@gmail.com> Signed-off-by: Ravina Hudda <ravina01@infosys.com>
hudda-ravina
force-pushed
the
Ravina_Hudda_Fix-pyspark
branch
from
48619e8 to
c343155
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 updates the PySpark API documentation to explicitly mention the return type of aggregate functions such as
stddev,stddev_samp,stddev_pop,variance,var_samp, andvar_pop.From inspecting the underlying implementation in
CentralMomentAgg.scala, these functions returnDoubleTyperegardless of input column type. However, this was not clearly documented in the PySpark function docstrings.This PR adds explicit mention of
DoubleTypein the return section of the relevant functions inbuiltin.py.Why are the changes needed?
Currently, the return type of these aggregate functions is not clearly documented, which may confuse users.
Adding this improves documentation clarity and aligns PySpark docs with actual implementation.
Does this PR introduce any user-facing change?
No. This is a documentation-only change.
How was this patch tested?
Documentation change only. Verified consistency with implementation in
CentralMomentAgg.scala.