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

[MATLAB] Update README.md to mention support for arrow.array.Array classes #36212

Closed
kevingurney opened this issue Jun 21, 2023 · 1 comment · Fixed by #36213
Closed

[MATLAB] Update README.md to mention support for arrow.array.Array classes #36212

kevingurney opened this issue Jun 21, 2023 · 1 comment · Fixed by #36213
Assignees
@kevingurney
Labels
Component: MATLAB Type: enhancement
Milestone
13.0.0

Comments

@kevingurney
Copy link
Member

Describe the enhancement requested

Now that the MATLAB interface supports creating a few different arrow.array.Array classes, it would be a good idea to update the README.md for the MATLAB interface to show a few more usage examples of working with the Array classes and to mention that the -D MATLAB_ARROW_INTERFACE=ON flag for building the MATLAB interface code.

Component(s)

MATLAB
@github-actions github-actions bot mentioned this issue Jun 21, 2023
Merged
@kevingurney
Copy link
Member Author

take

kou added a commit that referenced this issue Jun 22, 2023
@kevingurney @kou @sgilmore10
GH-36212: [MATLAB] Update README.md to mention support for `arrow.a…
990c297 
…rray.Array` classes (#36213)

### Rationale for this change

This pull request updates the `README.md` for the MATLAB interface to include a few more usage examples of working with the new `arrow.arrayArray` classes and to mention that the `-D MATLAB_ARROW_INTERFACE=ON` flag for building the MATLAB interface code. 

### What changes are included in this PR?

1. `README.md` updated to include usage examples for `arrow.array.Array` classes
2. `README.md` updated to mention `-D MATLAB_ARROW_INTERFACE=ON` flag 

### Are these changes tested?

"Yes". Manually verified that the changes look as expected visually.

### Are there any user-facing changes?

Yes. The `README.md` is now updated to include mention of the new `arrow.array.Array` classes.

### Future Directions

1. In the future, we plan to incrementally keep the `README.md` up to date (and potentially add more extensive documentation in other files) as we continue to build out the APIs for the MATLAB interface. We might consider restructuring the documentation more extensively as we move closer to a "v1" version of the MATLAB interface.

### Notes

1. Thanks @ sgilmore10 for your help with this pull request!
* Closes: #36212

Lead-authored-by: Kevin Gurney <[email protected]>
Co-authored-by: Kevin Gurney <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Co-authored-by: Sarah Gilmore <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
@kou kou added this to the 13.0.0 milestone Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kevingurney kevingurney

Labels
Component: MATLAB Type: enhancement
Projects
None yet
Milestone
13.0.0
Development

Successfully merging a pull request may close this issue.

GH-36212: [MATLAB] Update README.md to mention support for arrow.array.Array classes mathworks/arrow
2 participants
@kou @kevingurney