[GitHub] [arrow-rs] alamb commented on issue #1613: Improve arrow-rs examples

[GitBox <gi...@apache.org>]

alamb commented on issue #1613:
URL: https://github.com/apache/arrow-rs/issues/1613#issuecomment-1148490560

   Thank you @datapythonista ! That sounds like a great (and also quite ambitious) plan
   
   I remember @elferherrera may have worked on something similar so perhaps he has a comment.
   
   Most array types have examples in the rust docs (thanks to @novemberkilo ), for example https://docs.rs/arrow/15.0.0/arrow/array/struct.DictionaryArray.html and https://docs.rs/arrow/15.0.0/arrow/array/type.Int64Array.html -- perhaps we could create a 'cookbook' that has the key examples and then links to the docs for more details -- there may be some way to keep the content in the `cookbook` and then `include` them into the rust docs
   
   In general, it might be worth thinking how these examples will be maintained (specifically how to make sure they key working) -- rustdoc examples get automatically checked as part of CI and there is a way to run examples in markdown as well -- perhaps via https://crates.io/crates/doc-comment or something similar (example https://github.com/LaikaStudios/shotgrid-rs/pull/12/files)
   
   
   > Creating arrays with null values. I'm unsure about this one, if the above are simple enough, probably we can have this in the above examples. But worth having this here for consideration for now
   
   I agree that it may be enough to start with arrays with 


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org