[Gambas-user] Please work on documentation

[richard terry]

Add me to your list, if we form a group we can work together. May not be much 
help but I'll try.

Richard
On Sat, 2 Feb 2008 03:53:57 am Jeffrey Cobb wrote:
> I was thinking about this recently when I was browsing the documentation
> for Arrays.  There was plenty explanation what they are but NOT how you
> use them.  I tend to learn faster by example... so I got to thinking if
> it was possible for volunteers to be able to add code examples of how
> things are used... say an example of how THEY use that item in their
> project.
>
> It wouldn't take much time either... say about 15-30 min a day, and in a
> few months there'd be ample documentation for most functions.
>
> It isn't much and doesn't describe the item in detail but it's a start
> and gives a user a direction to go.
>
> Jeff
>
> On Fri, 2008-02-01 at 14:00 +0100, Benoit Minisini wrote:
> > On vendredi 1 février 2008, Leonardo Miliani wrote:
> > > I would ask the developing team to work on documentation before to go
> > > straight with Gambas3... please...
> > >
> > > One of the things that makes a software a _good_ software is
> > > documentation. A lot of users ask in this mailing list for the same
> > > thing: good docs.
> > > At the moment, the documentations laks in a very lot of points: things
> > > are not documentated, links are broken, some docs are old etc...
> > >
> > > I would suggest to stop development of Gambas for a couple of weeks and
> > > go completing the docs.
> > > Please please....
> >
> > You are right, but please please be more precise, otherwise your remark
> > is useless.
> >
> > I have not enough time to do all the developments I want on Gambas.
> > Consequently I don't have the time to write more documentation. I just
> > try to document the language and all the classes I wrote, and tell other
> > developers to document their classes, even if they usually, hem, forget
> > to do that.
> >
> > But even with all classes documented, you get mainly a reference
> > documentation, not a documentation that will explain you *how* to use all
> > these classes. So many people won't be satisfied anyway.
> >
> > Maybe your prayer will improve the situation? :-)
> >
> > Regards,
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2008.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Gambas-user mailing list
> Gambas-user at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/gambas-user