[gobolinux-users] Gobo wants you! (to comment its scripts)

[João Felipe Santos]

Nice! I'm kind of working with ChrootCompile and CompileFarm, and will add
my own comments if I find that's necessary.

-jfsantos

On Mon, Apr 7, 2008 at 9:28 AM, Demian Florentin <demianflorentin at gmail.com>
wrote:

> Excellent initiative!!
> +1
>
> On Mon, Apr 7, 2008 at 1:43 AM, Daniele Maccari <gobo.users at gmail.com>
> wrote:
> > Hello everybody,
> >
> >  me (macco) and Aitor (A_Tuin) started a little "project", which simply
> >  consists in commenting every single scripts used by GoboLinux to carry
> >  things out, thus making them a bit more comprehensible to normal people
> >  (and devs) not that deep into gobo since the first day.
> >
> >  So far, we're almost done with CheckDependencies and OptionParser.
> Aitor
> >  will star to look at the Scripts/Functions dir, which indeed has a lot
> >  of material to work on :D
> >
> >  No real guidelines exists, but as rules of thumb:
> >
> >  1- Don't comment every single line, just try to give an overwiew of
> what
> >  some function does, specifying what a line does only if really
> >  obscure/crucial.
> >
> >  2- We used the following format:
> >
> >  http://rafb.net/p/WdkyCe11.html (not definitive, it was a try of mine)
> >
> >  We don't really have any list, but as said before, starting from
> >  Functions would be nice, since every other script uses them, a way or
> >  the other.
> >
> >  When you'll feel comfortable with a comment, just create a patch for it
> >  and mail it to this topic, or look for some dev on #gobolinux. We'll
> add
> >  it as soon as it'll get reviewed ;)
> >
> >  So, thanks in advance to every single person who'll want to help us.
> >  Enjoy! :D
> >  _______________________________________________
> >  gobolinux-users mailing list
> >  gobolinux-users at lists.gobolinux.org
> >  http://lists.gobolinux.org/mailman/listinfo/gobolinux-users
> >
>
>
>
> --
> Demian.
> _______________________________________________
> gobolinux-users mailing list
> gobolinux-users at lists.gobolinux.org
> http://lists.gobolinux.org/mailman/listinfo/gobolinux-users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.gobolinux.org/pipermail/gobolinux-users/attachments/20080407/5b03e7da/attachment.htm