On Wed, 30 Oct 2013 12:58:41 -0300 Vinícius dos Santos Oliveira <vini.ipsma...@gmail.com> said:
> Em Qui, 2013-10-31 às 00:48 +0900, Carsten Haitzler escreveu: > > > this is simply a matter of time. spend 1hr adding a feature someone > > wants, or 1 > > hr writing docs. > > > Documentation is a feature too. in this case - for the minority of people. :) > > i personally use docs as reference only - i ALWAYS use example > > codee. nothing to do with java - it simply is faster, easier and more > > practical. > > Documentation can include snippets. yes - i know. i prefer just code. get rid of the english fluff. > > i read unix man pages to begin with and frankly they told me very > > little at all. a whole tonne of words for very little use. examples > > taught me > > 100x more in the same amount of effort with docs backing it up as > > reference. > > Comparing manpages with HTML rich (or even PDFs) docs.> > > * Manpages cannot have images (maybe with Terminology this is no > longer true) and for a GUI toolkit this is kind of a must. > * Manpages don't have an easily browsable content (like HTML) have i know. i spent some of my early life on unix/linux paying large sums for o'reilly books. and reading them cover to cover. they had diagrams. i frankly far prefer raw simple code over those books. the code is digestible in a fraction of the time. :) if i have an actual working bit of code i can compile it, run it and then modify it to see how it wobbles when poked. poke a bit more and see some more wobbling. these wobbles tell me the story of how CHANGES to the example affect the behaviour. start small with small changes and see. :) a book doesn't give me that. english words don't give me that. code does. :) but that is my style - i know that within all fields of education including foreign languages, math, science, etc. etc. i always gravitated to "learn by example". i naturally break up the examples into their constituent parts and know how to manipulate them - the pattern builds over time naturally. all i can offer here is - don't go massively rewrite some code within an app or toolkit you are not immensely familiar with. start small. start with some really minor augmentations very minor, and one small thing at a time - work towards what you ultimately want. each step teaches you something important. :) > * Summary > * Detailed description and extra sections > * Extra pages (not directly related to one class only) > * A small text for each function actually man pages do have these. ever seen the "see also" section? it is effectively links to other related pages. :) i've read a LOT of man pages. :) > > as such most of efl does have docs. they are not voluminous essays. > > again - a > > matter of time. if you wish to contribute by writing voluminous docs.. > > go for > > it. :) > > > The magic of open source. :) indeed. :) -- ------------- Codito, ergo sum - "I code, therefore I am" -------------- The Rasterman (Carsten Haitzler) ras...@rasterman.com ------------------------------------------------------------------------------ Android is increasing in popularity, but the open development platform that developers love is also attractive to malware creators. Download this white paper to learn more about secure code signing practices that can help keep Android apps secure. http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk _______________________________________________ enlightenment-users mailing list enlightenment-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-users
