3 ms·
I've read a few pages and browsed the rest, and it looks very interesting. I appreciate the personal touch and anecdotes. Also wanted to say that I 100% agree
by freetonik 3y ago
I've read a few pages and browsed the rest, and it looks very interesting. I appreciate the personal touch and anecdotes.
Also wanted to say that I 100% agree with the "minimum viable code snippets" idea. Too often a manual or a readme shows a snippet e.g. without imports, so you can't just run it as is.
Thank you for sharing!
- zerojames 3y agoThank you so much! I sincerely appreciate it! > minimum viable code snippets When I read documentation, I love when there are a few snippets I can read, copy-paste, and adapt to work with my code, particularly when a library is vast. Google does a good job of this, for example. In some of the cloud code snippets, you can copy-paste and they _just work_ (after you have authenticated). > e.g. without imports, so you can't just run it as is. I think it only makes sense to omit imports when a guide is walking through a single file (i.e. step-by-step), or future code snippets are a continuation of existing code. I also love it when guides specifically call out what package(s) I need to install.
- starkparker 3y agoFull context also makes the snippets easier to integrate into automated tests, which should be a requirement for examples in supported software.