kevingurney opened a new pull request, #37215:
URL: https://github.com/apache/arrow/pull/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. 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.


-- 
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]

Reply via email to