sgilmore10 opened a new pull request, #37826:
URL: https://github.com/apache/arrow/pull/37826
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's
Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing
Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor
PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes).
Could you open an issue for this pull request on GitHub?
https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the
[Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.)
of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
-->
### Rationale for this change
We should improve the display of `arrow.type.Field`, which currently looks
like this:
```matlab
>> arrow.field("A", arrow.int32())
ans =
A: int32
```
This display isn't very "MATLAB-like". For instance, it doesn't display the
object's class type. This display would be better:
```matlab
>> arrow.field("A", arrow.int32())
ans =
Field with properties:
Name: "A"
Type: [1x1 arrow.type.Int32Type]
```
### What changes are included in this PR?
1. Added `getPropertyGroups` method to `Field`. This method is inherited
from the superclass `matlab.mixin.CustomDisplay`.
2. Removed `displayScalarObject` method from `Field`. This method is also
inherited from `matlab.mixin.CustomDisplay`. By implementing
`getPropertyGroups`, we no longer need to override `displayScalarObject`.
3. Removed `toString()` method from `Field`. This method was private, and
only used by `displayScalarObject`. Now that `displayScalarObject` has been
removed, `toString()` can be deleted too.
4. Converted the helper test methods (`makeLinkString`,
`makeDimensionString`, `verifyDisplay`) in `tTypeDisplay` into standalone
functions. Doing so lets other test classes, such as `tField`, use them.
### Are these changes tested?
Yes. Added a `TestDisplay` unit test to `tField.m`.
### Are there any user-facing changes?
Yes. `arrow.type.Field` objects are now displayed differently in the Command
Window.
### Future Directions
1. Update the display of `arrow.tabular.Schema`.
2. Update the display of `arrow.array.Array`.
3. Update the display of `arrow.tabular.Table`.
4. Update the display of `arrow.tabular.RecordBatch`.
--
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]
