rust-cookbook icon indicating copy to clipboard operation
rust-cookbook copied to clipboard

Use consistent terminology for examples

Open brson opened this issue 7 years ago • 11 comments

Sometimes I call them "examples", sometimes "recipes". I like "recipes" better, but if we end up dropping the cooking metaphor for https://github.com/brson/rust-cookbook/issues/164 that will need to change.

For now let's just replace the word "example" with "recipe".

brson avatar May 26 '17 20:05 brson

@dtolnay what do you think of the word "recipe"?

brson avatar May 26 '17 20:05 brson

OK, now that I've written the word "recipe" like 20 times I'm getting that "weird word" sensation... like what do all those letters even mean?

brson avatar May 26 '17 20:05 brson

Recipe is fine but I agree this is contingent on #164.

dtolnay avatar May 26 '17 23:05 dtolnay

Well "Rust Recipes" is also a viable name for the book. It would still convey the "cookbook" idea without name collision and it rhymes ;)

budziq avatar May 27 '17 07:05 budziq

I think it's always good to compare it with what already exists, I am aware of Clojure Cookbook. From the first line of their README.md:

The book details a large number of recipes – pairs of problems and solutions – for common topics in Clojure.

Then searching "cookbook" in O'Reilly shows that there is a clear pattern among writers for this kind of book: "cookbook" is a list of "recipes" to solve programming tasks. I am in favor of "recipe" as well.

ludwigpacifici avatar Oct 09 '17 15:10 ludwigpacifici

Greetings!

I'm a fledgling in the open source world, however I'd love to take on this task if help is still needed. Any feedback / advice along the way would also be greatly appreciated. Thank you!

kimstacy avatar Feb 21 '20 22:02 kimstacy

Great! Do you know how to fork and clone your fork locally?

AndyGauge avatar Feb 21 '20 22:02 AndyGauge

@AndyGauge I do! I'm so excited!

Thank you so much for asking! Are there any recent updates you'd like me to be aware of before approaching? I will be doing all of the necessary research through the existing codebase + related project updates before I begin. I will also post here should I have any questions along the way!

kimstacy avatar Feb 22 '20 00:02 kimstacy

Sure,

This particular issue was a grounds for discussing naming of our samples. I would say we officially landed keeping the cookbook theme, and as such should move towards reviewing the content and making changes that reflect the cooking theme, like examples should be recipes. If you have time and are eager to review the language here, I'm happy to merge/support the process. In fact I have a little project that I started and haven't made time for and might just be looking for somebody to finish it for me. #564

AndyGauge avatar Feb 22 '20 00:02 AndyGauge

@AndyGauge Thank you for clarifying! I am beyond impressed by how welcoming, kind, and supportive your organization is. Thank you for the helpful encouragement! I am eager to take this on and would love to help with additional projects. I intend to submit the updated revision this week.

kimstacy avatar Feb 24 '20 04:02 kimstacy

@AndyGauge @brson Hi, I'm new to open source and would love to work on this!

paridhi7 avatar Sep 04 '20 17:09 paridhi7