Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Ruby] Arrow::Table#initialize's raw_records document is wrong #37239

Closed
kou opened this issue Aug 18, 2023 · 3 comments · Fixed by #37261
Closed

[Ruby] Arrow::Table#initialize's raw_records document is wrong #37239

kou opened this issue Aug 18, 2023 · 3 comments · Fixed by #37261
Assignees
@otegami
Labels
Component: Ruby Type: bug
Milestone
14.0.0

Comments

@kou
Copy link
Member

kou commented Aug 18, 2023

Describe the bug, including details regarding any error messages, version, and platform.

arrow/ruby/red-arrow/lib/arrow/table.rb

Lines 148 to 149 in 9fea4ee

# @param arrays [::Array<::Array>] The data of the table as primitive
# Ruby objects.

It should explain raw_records not arrays.

Component(s)

Ruby
@kou kou added the Type: bug label Aug 18, 2023
@kou
Copy link
Member Author

kou commented Aug 18, 2023

@heronshoes @otegami Are you interested in this?

@otegami
Copy link
Contributor

otegami commented Aug 18, 2023

@kou I will fix it 🫡

@otegami otegami mentioned this issue Aug 19, 2023
Merged
@otegami
Copy link
Contributor

otegami commented Aug 19, 2023

@kou
Thank you for bringing up this issue. I've addressed it in this pull request: #37261.
Whenever you're available, could you please take a look?

@kou kou added this to the 14.0.0 milestone Aug 20, 2023
kou pushed a commit that referenced this issue Aug 20, 2023
@otegami
GH-37239: [Ruby] Updated documentation for ArrowTable#initialize to c…
6357c9f 
…larify argument details (#37261)

### What changes are included in this PR?
Fixed the documentation for ArrowTable#initialize about the followings
- initialize(schema, record_batches)
- initialize(schema, raw_records)

* Closes: #37239

Authored-by: otegami <a.s.takuya1026@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@otegami @loicalleyne
apacheGH-37239: [Ruby] Updated documentation for ArrowTable#initializ…
0bf5f92 
…e to clarify argument details (apache#37261)

### What changes are included in this PR?
Fixed the documentation for ArrowTable#initialize about the followings
- initialize(schema, record_batches)
- initialize(schema, raw_records)

* Closes: apache#37239

Authored-by: otegami <a.s.takuya1026@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@otegami otegami

Labels
Component: Ruby Type: bug
Projects
None yet
Milestone
14.0.0
2 participants
@kou @otegami