[GitHub] [arrow-cookbook] amol- commented on issue #116: Difference between cookbook and user guide docs

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

amol- commented on issue #116:
URL: https://github.com/apache/arrow-cookbook/issues/116#issuecomment-1010064704


   Hi Will,
   
   The Cookbook aims at being a collection of solutions to specific problems that the user can copy/paste in its own code. The cookbook is meant to be an answer to a specific question that the user would probably search on google on stackoverflow.
   Some of those questions will be trivial like how to read CSV, some of those will be more advanced, that doesn't matter too much. If there is someone searching for that question the cookbook should have an answer for it.
   
   The standard documentation instead is more focused on learning. It should provide you tutorials (learn by doing) and explanations and examples. Some of those examples might obviously match with cookbook recipes in some trivial cases, but while the code is similar the purpose they serve is very different.
   
   While Arrow doesn't strictly follow the model, https://diataxis.fr/ has a good description of the difference between "How-to Guides" (the cookbook) and "Tutorials" and "Explanation" (the standard arrow docs).
   


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