Re: [Vala] Examples in documentation

[Brian Duffy <brduffy gmail com>]

Looks like the "mark up" section is describing how comments might be added
in the future. My own opinion is that this is overkill. We want to make it
easy for people to leave comments. I would rather see something more like
how php does it. Just allow plain text and then everything within some
designated begin and close tag is listed as code.


On Thu, Nov 8, 2012 at 10:32 AM, Brian Duffy <brduffy gmail com> wrote:

> Here we can see that community comments have been in the planning (since
> February).
>
> http://valajournal.blogspot.com/2012/02/valadoc-website-renewal.html
>
> I'm guessing it is this moderator issue that is holding things back. I
> wish I were qualified to be the moderator myself.
>
>
> On Thu, Nov 8, 2012 at 7:43 AM, Gilzad Hamuni <gilli4 gmx net> wrote:
>
> > Hi all,
> >
> > maybe it's already there and I missed to see it. Is it possible to have
> > some account on an existing valadoc-page, so one could add code-examples
> > online rather than working with the markup locally?
> >
> >
> > Knowing that vala is still evolving, I'm facing one issue that probably
> > could be solved rapidly.
> >
> > Except of the given tutorials, if someone wants to implement some feature
> > in his application, he either has to
> >
> > 1) guess how he'd use the vala bindings (requires firm experience with
> > glib) or
> >
> > 2) he has to derive the vala-code from some existing C-code, that is
> > using the same library or
> >
> > 3) crawl through some existing vala-projects that would offer an example,
> > somewhere deep inside their source.
> >
> >
> > Now, once a dev has achieved to have some working code, he might want to
> > share this as an example, so others will quickly find out how to use
> > function X from vapi Y.
> >
> > Wouldn't it boost vala's easy-to-efficient-ratio, if code-examples were
> > attached to the documentation (like on msdn or php.net)? Maybe it could
> > be some great advertising, too "Wow, that's just a three-liner!".
> >
> >
> > Sorry if this has been discussed before, I couldn't find anything related
> > after a quick search.
> >
> > Best,
> >
> > Gilzad
> > _______________________________________________
> > vala-list mailing list
> > vala-list gnome org
> > https://mail.gnome.org/mailman/listinfo/vala-list
>
>
>
> --
> Duff



-- 
Duff