-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
[Docs][MATLAB] Update MATLAB README.md
to mention support for new MATLAB APIs (e.g. RecordBatch
, Field
, Schema
, etc.)
#37210
Comments
README.md
to mention support for new MATLAB APIs (e.g. RecordBatch
, Field
, Schema
, etc.)README.md
to mention support for new MATLAB APIs (e.g. RecordBatch
, Field
, Schema
, etc.)
Added label |
kevingurney
added a commit
that referenced
this issue
Aug 17, 2023
… for new MATLAB APIs (e.g. `RecordBatch`, `Field`, `Schema`, etc.) (#37215) ### Rationale for this change Over the last few months, a number of new user-facing APIs have been added or changed in the MATLAB Interface. ## Examples: ### Construction Functions - `arrow.array` - `arrow.field` - `arrow.schema` - `arrow.recordbatch` - `arrow.boolean`, `arrow.string`, `arrow.timestamp`, etc. (type construction functions) ### Classes - `arrow.type.Field` - `arrow.tabular.Schema` - `arrow.tabular.RecordBatch` - `arrow.array.StringArray` - `arrow.array.TimestampArray` ### Indexing Methods - `arrow.tabular.Schema.field(i)` - `arrow.tabular.RecordBatch.column(i)` ### Static Construction Methods - `arrow.tabular.RecordBatch.fromArrays(a1, ..., aN)` - `arrow.array.StringArray.fromMATLAB(a)` --- This pull request updates the [`README.md` for the MATLAB Interface](https://github.com/apache/arrow/blob/main/matlab/README.md) to reflect these changes. ### What changes are included in this PR? Updated MATLAB `README.md`: 1. Updated **Status** section to mention support for new Arrow types and functionality. 2. Added usage examples for `Type, `Field`, `Schema`, and `RecordBatch`. 3. Updated Feather v1 usage examples to illustrate support for types like `String` and `Boolean`. ### Are these changes tested? N/A. This is purely a documentation change. I manually reviewed the visual rendering of the `README.md` Markdown on GitHub. ### Are there any user-facing changes? Yes. 1. The MATLAB `README.md` now includes more usage examples which illustrate how to use the MATLAB interface. ### Future Directions 1. Add comprehensive documentation for all classes and methods, including supported input argument types and name-value pairs. 2. Add more detailed information on future development plans and development status to the `README.md`. 3. Add a table of contents to the MATLAB `README.md`. 4. Keep the `README.md` up to date more proactively. ### Notes 1. Thank you @ sgilmore10 for your help with this pull request! 2. My apologies in advance if this is too much documentation content to review at once. We will focus on being more incremental about keeping the MATLAB documentation up to date in the future. 3. #37211 also involves updating the MATLAB `README.md`, so there is a chance we may need to rebase before merging these changes in. * Closes: #37210 Lead-authored-by: Kevin Gurney <kgurney@mathworks.com> Co-authored-by: Kevin Gurney <kevin.p.gurney@gmail.com> Co-authored-by: Sutou Kouhei <kou@cozmixng.org> Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
loicalleyne
pushed a commit
to loicalleyne/arrow
that referenced
this issue
Nov 13, 2023
…upport for new MATLAB APIs (e.g. `RecordBatch`, `Field`, `Schema`, etc.) (apache#37215) ### Rationale for this change Over the last few months, a number of new user-facing APIs have been added or changed in the MATLAB Interface. ## Examples: ### Construction Functions - `arrow.array` - `arrow.field` - `arrow.schema` - `arrow.recordbatch` - `arrow.boolean`, `arrow.string`, `arrow.timestamp`, etc. (type construction functions) ### Classes - `arrow.type.Field` - `arrow.tabular.Schema` - `arrow.tabular.RecordBatch` - `arrow.array.StringArray` - `arrow.array.TimestampArray` ### Indexing Methods - `arrow.tabular.Schema.field(i)` - `arrow.tabular.RecordBatch.column(i)` ### Static Construction Methods - `arrow.tabular.RecordBatch.fromArrays(a1, ..., aN)` - `arrow.array.StringArray.fromMATLAB(a)` --- This pull request updates the [`README.md` for the MATLAB Interface](https://github.com/apache/arrow/blob/main/matlab/README.md) to reflect these changes. ### What changes are included in this PR? Updated MATLAB `README.md`: 1. Updated **Status** section to mention support for new Arrow types and functionality. 2. Added usage examples for `Type, `Field`, `Schema`, and `RecordBatch`. 3. Updated Feather v1 usage examples to illustrate support for types like `String` and `Boolean`. ### Are these changes tested? N/A. This is purely a documentation change. I manually reviewed the visual rendering of the `README.md` Markdown on GitHub. ### Are there any user-facing changes? Yes. 1. The MATLAB `README.md` now includes more usage examples which illustrate how to use the MATLAB interface. ### Future Directions 1. Add comprehensive documentation for all classes and methods, including supported input argument types and name-value pairs. 2. Add more detailed information on future development plans and development status to the `README.md`. 3. Add a table of contents to the MATLAB `README.md`. 4. Keep the `README.md` up to date more proactively. ### Notes 1. Thank you @ sgilmore10 for your help with this pull request! 2. My apologies in advance if this is too much documentation content to review at once. We will focus on being more incremental about keeping the MATLAB documentation up to date in the future. 3. apache#37211 also involves updating the MATLAB `README.md`, so there is a chance we may need to rebase before merging these changes in. * Closes: apache#37210 Lead-authored-by: Kevin Gurney <kgurney@mathworks.com> Co-authored-by: Kevin Gurney <kevin.p.gurney@gmail.com> Co-authored-by: Sutou Kouhei <kou@cozmixng.org> Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the enhancement requested
Over the last few months, a number of new user-facing APIs have been added or changed in the MATLAB Interface.
Examples:
Construction Functions
arrow.array
arrow.field
arrow.schema
arrow.recordbatch
arrow.boolean
,arrow.string
,arrow.timestamp
, etc. (type construction functions)Classes
arrow.type.Field
arrow.tabular.Schema
arrow.tabular.RecordBatch
arrow.array.StringArray
arrow.array.TimestampArray
Indexing Methods
arrow.tabular.Schema.field(i)
arrow.tabular.RecordBatch.column(i)
Static Construction Methods
arrow.tabular.RecordBatch.fromArrays(a1, ..., aN)
arrow.array.StringArray.fromMATLAB(a)
We should update the
README.md
for the MATLAB Interface to reflect these changes.Component(s)
MATLAB
The text was updated successfully, but these errors were encountered: