findepi commented on PR #11225: URL: https://github.com/apache/datafusion/pull/11225#issuecomment-2204177085
> Maybe we could look to make them as self contained as possible (perhaps provide a self contained example of querying from record batches in memory) 🤔 that's a good idea. but CSV APIs still deserve some examples, so the problem remains > to move the examples to the user guide: #11217. Improving the docs is definitely a good idea and having examples in docs tested is so nice. it has one downside -- it feels less approachable for a new contributor. A contributor may want to run examples directly and be able to modify them, and I assume it's less easy to do when they are embedded in markdown. (also don't know whether cargo's examples feature is important to keep) > As a relatively new user of DataFusion what would you find most helpful? As a user, i would prefer to have working examples within docs. As soon as a I clone the repository, so as a contributor, I would prefer to have examples runnable from my IDE. I don't know whether it's possible to have both without duplicating the content. -- 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]
