Skip to content

Conversation

@kevingurney
Copy link
Member

Overview

This pull request:

  1. Updates the high level documentation for the MATLAB interface in arrow/matlab/README.md to reflect the latest CMake build system changes that were merged upstream as part of #12004.

Implementation

  1. Restructured the README.md to focus on the most common build and test workflows for the MATLAB interface.

Testing

N/A

Future Directions

  1. To be consistent and in-model with the other language bindings (e.g. Python, R, C++, etc.) - we plan to author in-depth technical documentation over time under arrow/docs/source/matlab using the reStructedText (.rst) format. The thought behind this README.md documentation is to provide a convenient "landing page" for the MATLAB interface which allows end users to quickly get a sense of where the project is at and to get started immediately with building and running the interface. However, every user and developer will have different use cases and needs for working with the MATLAB interface, so we will also want include in-depth documentation for major topics like building, installing, testing, contributing, usage, etc. As the MATLAB interface continues to develop, we will do our best to keep the documentation in sync with the source code.

Notes

  1. Thank you to @lafiona for her help writing this updated documentation!

@github-actions
Copy link

github-actions bot commented Feb 9, 2022

@github-actions
Copy link

github-actions bot commented Feb 9, 2022

⚠️ Ticket has not been started in JIRA, please click 'Start Progress'.

Use "console" instead of "bash" as the language for syntax highlighting inside of fenced code blocks containing command line operations.

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@kevingurney
Copy link
Member Author

@kou - thank you for reviewing this pull request! I've accepted your suggested changes.

My apologies for using bash instead of console. I wasn't aware that console was an option for syntax highlighting.

Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

No problem. :-)

@kou kou closed this in e4f6587 Feb 10, 2022
@ursabot
Copy link

ursabot commented Feb 10, 2022

Benchmark runs are scheduled for baseline = 401746b and contender = e4f6587. e4f6587 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️0.47% ⬆️0.0%] test-mac-arm
[Finished ⬇️1.43% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.22% ⬆️0.0%] ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@kevingurney kevingurney deleted the ARROW-13204 branch August 21, 2023 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants