kevingurney opened a new pull request #12389:
URL: https://github.com/apache/arrow/pull/12389


   # 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](https://github.com/apache/arrow/pull/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`](https://github.com/apache/arrow/tree/master/docs/source)
 using the [reStructedText (.rst) 
format](https://docutils.sourceforge.io/rst.html). 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!


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