[SPARK-32771][DOCS] The example of expressions.Aggregator in Javadoc / Scaladoc is wrong #29617
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
|
Test build #128160 has finished for PR 29617 at commit
|
HyukjinKwon
approved these changes
Sep 2, 2020
HyukjinKwon
pushed a commit
that referenced
this pull request
Sep 2, 2020
…/ Scaladoc is wrong ### What changes were proposed in this pull request? This PR modifies an example for `expressions.Aggregator` in Javadoc and Scaladoc. The definition of `bufferEncoder` and `outputEncoder` are added. ### Why are the changes needed? To correct the example. The current example is wrong and doesn't work because `bufferEncoder` and `outputEncoder` are not defined. ### Does this PR introduce _any_ user-facing change? Yes. Before this change, the scaladoc and javadoc are like as follows.   After this change, the docs are like as follows.   ### How was this patch tested? Build with `build/sbt unidoc` and confirmed the generated javadoc/scaladoc and got the screenshots above. Closes #29617 from sarutak/fix-aggregator-doc. Authored-by: Kousuke Saruta <sarutak@oss.nttdata.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org> (cherry picked from commit 812d091) Signed-off-by: HyukjinKwon <gurwls223@apache.org>
|
Merged to master, branch-3.0 and branch-2.4. |
HyukjinKwon
pushed a commit
that referenced
this pull request
Sep 2, 2020
…/ Scaladoc is wrong ### What changes were proposed in this pull request? This PR modifies an example for `expressions.Aggregator` in Javadoc and Scaladoc. The definition of `bufferEncoder` and `outputEncoder` are added. ### Why are the changes needed? To correct the example. The current example is wrong and doesn't work because `bufferEncoder` and `outputEncoder` are not defined. ### Does this PR introduce _any_ user-facing change? Yes. Before this change, the scaladoc and javadoc are like as follows.   After this change, the docs are like as follows.   ### How was this patch tested? Build with `build/sbt unidoc` and confirmed the generated javadoc/scaladoc and got the screenshots above. Closes #29617 from sarutak/fix-aggregator-doc. Authored-by: Kousuke Saruta <sarutak@oss.nttdata.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org> (cherry picked from commit 812d091) Signed-off-by: HyukjinKwon <gurwls223@apache.org>
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 modifies an example for
expressions.Aggregatorin Javadoc and Scaladoc.The definition of
bufferEncoderandoutputEncoderare added.Why are the changes needed?
To correct the example.
The current example is wrong and doesn't work because
bufferEncoderandoutputEncoderare not defined.Does this PR introduce any user-facing change?
Yes.
Before this change, the scaladoc and javadoc are like as follows.
After this change, the docs are like as follows.
How was this patch tested?
Build with
build/sbt unidocand confirmed the generated javadoc/scaladoc and got the screenshots above.