-
Notifications
You must be signed in to change notification settings - Fork 4k
ARROW-13204: [MATLAB] Update documentation for the MATLAB Interface to reflect latest CMake build system changes #12389
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
Conversation
2. Remove information about non-standard workflows from main README.md file.
2. Add softare Prerequisites. 3. Tweak wording.
|
|
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>
|
@kou - thank you for reviewing this pull request! I've accepted your suggested changes. My apologies for using |
kou
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
No problem. :-)
|
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. |
Overview
This pull request:
arrow/matlab/README.mdto reflect the latest CMake build system changes that were merged upstream as part of #12004.Implementation
README.mdto focus on the most common build and test workflows for the MATLAB interface.Testing
N/A
Future Directions
arrow/docs/source/matlabusing the reStructedText (.rst) format. The thought behind thisREADME.mddocumentation 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