alamb commented on issue #11336: URL: https://github.com/apache/datafusion/issues/11336#issuecomment-3121741642
> > Thank you [@Adez017](https://github.com/Adez017) -- I would personally suggest starting by porting some of the contents of https://jorgecarleitao.github.io/arrow2/main/guide/ into DataFUsion's docs > > In terms of mechanism, I personally suggest making a PR into the arrow-rs repo: https://github.com/apache/arrow-rs and making the documentation doc comments in the arrow crate > > This would mean they docs show up here: > > > > * https://docs.rs/arrow/latest/arrow/index.html > > > > And it will ensure the examples contine to run > > I suggest starting with the sections > > > > * Arrow format > > * high level API > > > > And see how that goes > > hi [@alamb](https://github.com/alamb) just a quick follow up , i got a little confused whether i need to PR the arrow-rs or datafusion and also in which specific folder . Thanks @Adez017 -- ideally we could put this in the arrow-rs repo -- perhaps we could make a new module called `intro.rs` somewhere like https://github.com/apache/arrow-rs/blob/main/arrow/src/intro.rs that simply has a large doc comment with the guide, and then we can link that module from https://github.com/apache/arrow-rs/blob/main/arrow/src/lib.rs 🤔 -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
