On Mon, Feb 18, 2013 at 4:53 PM, Leif Middelschulte <leif.middelschu...@gmail.com> wrote: > Am Montag, 18. Februar 2013 um 20:34 schrieb Davide Andreoli: >> 2013/2/18 Leif Middelschulte <leif.middelschu...@gmail.com >> (mailto:leif.middelschu...@gmail.com)> >> >> > Hello everyone, >> > >> > Every few days I come across some functionality that isn't usable >> > 'straight forward' but isn't explicitly documented either. After asking on >> > IRC I usually go back to read the library's C code, which sometimes is >> > quite a bit time consuming. >> > >> > Since I strongly believe that many problems and their respective solutions >> > are reoccurring, I'd like to have some sort of searchable snippets for EFL >> > usage. >> > >> > I'm referring to short snippets, not to full fledged examples that could >> > be added to examples/ or deserve a blog entry/whatever. >> > >> > Let me give you an example: >> > Problem: Change an edje part's rel1 value via message using embryo >> > Straight forward solution I assumed: >> > set_state_val(…) >> > Real solution: >> > custom_state(…) >> > set_state_val(…) >> > set_state(…) >> > >> >> >> exactly this is explained in the example: >> efl/src/examples/edje/embryo_custom_state.edc >> >> > > I didn't want a custom state. I wanted to modify the current one. So this is > - imo - not straight forward! Nevertheless I found an example that showed it. >> > >> > Now I'd go and create a snippet that contains only the few correct lines + >> > comments and tag it with e.g.: "edje part geometry change rel1 embryo >> > message" >> > >> > I imagine a dedicated git repository (e.g. 'snippets') that contains >> > tagged code snippets (first commit line) and a web interface to eventually >> > add/edit/browse/search entries. Luckily we have phabricator, which already >> > provides all of this :-) Now we'd just need to add such a repository. >> > >> > What do you guys think? >> >> I don't think a new place to put example is a good idea, will make the >> search of resources more difficult. We have example/test/snippets too much >> sparse around: in sources, in the wiki, in examples, in tests... I think we >> need a sort of >> "contentrator" for all that info around. > > As I wrote it's not about full examples, just snippets! > Are you familiar with gists? (see http://gist.github.com) > I don't have the time to write out entire examples, but have the time to > copy/paste a few lines I just coded/figured out and add some comments to them. >> Maybe a well done wiki page can be enough, I'm thinking of a sort of "big >> index" of resources grouped by libs. > > If we'd use a git repository you could use tools of your choice (e.g. grep) > to search the given snippets for matching tags (either we embed them into the > commit message or into the files).
My suggestion: go for it. If you think it's useful most probably somebody else will agree with you and she'll start to use / contribute snippets. I prefer to spend my time reading / writing full examples, because you can build and test them. You are sure it works before spending your time reading it. And they are useful for testing the lib. Snippets can be wrong, outdated, etc. I've never used it as a valid resource in my development flow, but if you like it you should go ahead with your idea. >> > >> > -- >> > Leif >> > >> > >> > ------------------------------------------------------------------------------ >> > The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, >> > is your hub for all things parallel software development, from weekly >> > thought >> > leadership blogs to news, videos, case studies, tutorials, tech docs, >> > whitepapers, evaluation guides, and opinion stories. Check out the most >> > recent posts - join the conversation now. >> > http://goparallel.sourceforge.net/ >> > _______________________________________________ >> > enlightenment-devel mailing list >> > enlightenment-devel@lists.sourceforge.net >> > (mailto:enlightenment-devel@lists.sourceforge.net) >> > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel >> > >> >> ------------------------------------------------------------------------------ >> The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, >> is your hub for all things parallel software development, from weekly thought >> leadership blogs to news, videos, case studies, tutorials, tech docs, >> whitepapers, evaluation guides, and opinion stories. Check out the most >> recent posts - join the conversation now. http://goparallel.sourceforge.net/ >> _______________________________________________ >> enlightenment-devel mailing list >> enlightenment-devel@lists.sourceforge.net >> (mailto:enlightenment-devel@lists.sourceforge.net) >> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel > > > ------------------------------------------------------------------------------ > The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, > is your hub for all things parallel software development, from weekly thought > leadership blogs to news, videos, case studies, tutorials, tech docs, > whitepapers, evaluation guides, and opinion stories. Check out the most > recent posts - join the conversation now. http://goparallel.sourceforge.net/ > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel -- Bruno Dilly Lead Developer ProFUSION embedded systems http://profusion.mobi ------------------------------------------------------------------------------ The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials, tech docs, whitepapers, evaluation guides, and opinion stories. Check out the most recent posts - join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
