edmondop opened a new issue, #10768:
URL: https://github.com/apache/datafusion/issues/10768

   ### Is your feature request related to a problem or challenge?
   
   Datafusion documentation is amazing and examples are too. However, inline 
snippets might fall out of sync from the codebase and are not very easy to 
consume because you often need to figure out the required imports to get a 
snippet to compile. On the other side, writing a full Rust script in a 
documentation page creates too much noise and make the documentation less 
effective.
   
   
   
   ### Describe the solution you'd like
   
   Ideally, we would have snippets that are portions of executable scripts, so 
that we can via CI/CD execute them and confirm they are not obsolete, but at 
the same time only the relevant section of the script is included in the docs.
   
   We can use https://github.com/temporalio/snipsync for the purpose
   
   ### Describe alternatives you've considered
   
   _No response_
   
   ### Additional context
   
   I was working on a separate issue for documentation, and I have found myself 
facing the problem that I mentioned above, see 
https://github.com/apache/datafusion/issues/7306#issuecomment-2131289288


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

Reply via email to