a few questions regarding documentation

[chrisichris]

Hi,

Thanks madis for the new yeti-doc generator this one is realy nice. I have just some questions/remarks:

1.) It is hard to find, because there is no online-doc for std and io modules. Maybe this could be added beside the tutorial on the yeti home-page

2.) Maybe also a reference to the source-code could be added to the docs. I think this is very handy and can also teach a lot how to code in yeti.

3.) a bit "dreaming" further: what I like about the dynamic uncompiled languages is that you always also see the source and can get the doc for a function right away from the repl (ie doc or find-doc in clojure) without searching it on the internet with right version etc. So I was thinking of maybe adding the *.yeti source files to yeti jars (would take about additional 13KB) and than writing some functions in std which display doc/source for some functions. I could also write a smale web-server so you can see the doc which is actually on the classpath right in the browser always as soon as the jar is downloaded.

[Madis]

On Fri, 27 Apr 2012, chrisichris wrote:

> Hi,
> Thanks madis for the new yeti-doc generator this one is realy nice. I have
> just some questions/remarks:
>
> 1.) It is hard to find, because there is no online-doc for std and io
> modules. Maybe this could be added beside the tutorial on the yeti home-page
> 2.) Maybe also a reference to the source-code could be added to the docs. I
> think this is very handy and can also teach a lot how to code in yeti.

Yes, but it's not finished (half of functions are not properly
documented). I hope to find some time in summer to get it done.

> 3.) a bit "dreaming" further: what I like about the dynamic uncompiled
> languages is that you always also see the source and can get the doc for a
> function right away from the repl (ie doc or find-doc in clojure) without
> searching it on the internet with right version etc. So I was thinking of
> maybe adding the *.yeti source files to yeti jars (would take about
> additional 13KB) and than writing some functions in std which display
> doc/source for some functions.

I'l think about adding the library source to the full jar. Actually most
efficient should be adding uncompressed src zip into jar, so that it would
be compressed at once.