Skip to content

Commit

Permalink
GH-37210: [Docs][MATLAB] Update MATLAB README.md to mention support…
Browse files Browse the repository at this point in the history
… 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 <[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: Kevin Gurney <[email protected]>
  • Loading branch information
4 people authored Aug 17, 2023
1 parent 4fc2731 commit 7d8e4b1
Showing 1 changed file with 417 additions and 15 deletions.
Loading

0 comments on commit 7d8e4b1

Please sign in to comment.