kou commented on code in PR #15088:
URL: https://github.com/apache/arrow/pull/15088#discussion_r1057395183
##########
ruby/red-arrow/lib/arrow/table.rb:
##########
@@ -448,40 +448,52 @@ def pack
self.class.new(schema, packed_arrays)
end
- # @overload join(right, key, type: :inner, left_outputs: nil,
right_outputs: nil)
- # @!macro join_common_before
- # @param right [Arrow::Table] The right table.
+ # Join another Table by matching with keys.
+ #
+ # @!macro join_common_before
+ # @param right [Arrow::Table] The right table.
+ #
+ # Join columns with `right` on join key columns.
#
- # Join columns with `right` on join key columns.
+ # @!macro join_common_after
+ # @param type [Arrow::JoinType] How to join.
+ # @param left_outputs [::Array<String, Symbol>] Output columns in
+ # `self`.
#
- # @!macro join_common_after
- # @param type [Arrow::JoinType] How to join.
- # @param left_outputs [::Array<String, Symbol>] Output columns in
- # `self`.
+ # If both of `left_outputs` and `right_outputs` aren't
+ # specified, all columns in `self` and `right` are
+ # outputted.
+ # @param right_outputs [::Array<String, Symbol>] Output columns in
+ # `right`.
+ #
+ # If both of `left_outputs` and `right_outputs` aren't
+ # specified, all columns in `self` and `right` are
+ # outputted.
+ # @return [Arrow::Table]
+ # The joined `Arrow::Table`.
#
- # If both of `left_outputs` and `right_outputs` aren't
- # specified, all columns in `self` and `right` are
- # outputted.
- # @param right_outputs [::Array<String, Symbol>] Output columns in
- # `right`.
+ # @overload join(right, type: :inner, left_outputs: nil, right_outputs:
nil)
+ # If key(s) are not supplied, common keys in self and right are used.
#
- # If both of `left_outputs` and `right_outputs` aren't
- # specified, all columns in `self` and `right` are
- # outputted.
- # @return [Arrow::Table]
- # The joined `Arrow::Table`.
+ # @macro join_common_before
+ # @macro join_common_after
+ #
Review Comment:
```suggestion
#
# @since 11.0.0
#
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
