-
Notifications
You must be signed in to change notification settings - Fork 29k
[SPARK-24275][SQL] Revise doc comments in InputPartition #21326
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
Conversation
|
Test build #90620 has finished for PR 21326 at commit
|
| * Note that if a host name cannot be recognized by Spark, it will be ignored as it was not in | ||
| * the returned locations. By default this method returns empty string array, which means this | ||
| * task has no location preference. | ||
| * data reader has no location preference. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
input partition
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or this input partition's reader
|
lgtm except one comment |
|
Test build #90649 has finished for PR 21326 at commit
|
|
Test build #90650 has finished for PR 21326 at commit
|
|
thanks, merging to master! |
| * Returns a list of read tasks. Each task is responsible for creating a data reader to | ||
| * output data for one RDD partition. That means the number of tasks returned here is same as | ||
| * the number of RDD partitions this scan outputs. | ||
| * Returns a list of {@link InputPartition}s. Each {@link InputPartition} is responsible for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Instead of {@link InputPartition}s use {@link InputPartition partitions} to add the plural. That avoids awkward formatting and links that are missing 's'.
|
Belated +1. In the future, I think it is better for readable docs to pluralize linked terms as I suggested in a comment. |
## What changes were proposed in this pull request? In apache#21145, DataReaderFactory is renamed to InputPartition. This PR is to revise wording in the comments to make it more clear. ## How was this patch tested? None Author: Gengliang Wang <gengliang.wang@databricks.com> Closes apache#21326 from gengliangwang/revise_reader_comments. (cherry picked from commit 6fb7d6c)
## What changes were proposed in this pull request? In apache#21145, DataReaderFactory is renamed to InputPartition. This PR is to revise wording in the comments to make it more clear. ## How was this patch tested? None Author: Gengliang Wang <gengliang.wang@databricks.com> Closes apache#21326 from gengliangwang/revise_reader_comments.
## What changes were proposed in this pull request? In apache#21145, DataReaderFactory is renamed to InputPartition. This PR is to revise wording in the comments to make it more clear. ## How was this patch tested? None Author: Gengliang Wang <gengliang.wang@databricks.com> Closes apache#21326 from gengliangwang/revise_reader_comments. (cherry picked from commit 6fb7d6c)
In apache#21145, DataReaderFactory is renamed to InputPartition. This PR is to revise wording in the comments to make it more clear. None Author: Gengliang Wang <gengliang.wang@databricks.com> Closes apache#21326 from gengliangwang/revise_reader_comments. Ref: LIHADOOP-48531
What changes were proposed in this pull request?
In #21145, DataReaderFactory is renamed to InputPartition.
This PR is to revise wording in the comments to make it more clear.
How was this patch tested?
None