xxchan commented on issue #4071: URL: https://github.com/apache/arrow-rs/issues/4071#issuecomment-1576901007
Thanks. The docs are indeed very helpful! However, my user journey is like: Wow, there are so many sub-crates! And ... what on earth do they mean? <img width="1138" alt="image" src="https://github.com/apache/arrow-rs/assets/37948597/59a481de-13ea-4dc0-9b50-d0b48cb9c0db";> Well, let me go to arrow-buffer / arrow-data and check it. Oops, there aren't many useful infomation either.. What is "Buffer abstraction"? <img width="1141" alt="image" src="https://github.com/apache/arrow-rs/assets/37948597/d0fc1fb5-1e9e-45d9-ad74-7eec960349a5";> So it seems good doc exists, but are not **accessible** enough. Ways to improve I can come up with now: - Better "introduction" section in crate-level docs. - root `arrow` crate can group sub-crates (e.g., low-level/high-level/compute kernal, like the arrow2's doc) and add more description, instead of simply enumerating them. - sub-crate may need some more explanations (at least mention that refer to some struct's doc for more details) - It seems high-level API (Array) explains low-level API (Buffer), but not the reverse. Maybe a backlink can be added to explain the relationship. -- 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]
