Re: [Bug 20254] Add code examples

On Fri, Dec 7, 2012 at 9:48 PM, Peter Nyboer <pnyboer@slambassador.com>wrote:

> A separate example question. I had this issue w/ RafaelJS recently  - the
> Demos are kind of elaborate, and the examples in the documentation are over
> simple, probably for the sake of documentary brevity. That's nice, but a
> simple example that shows something "at work" with a couple other elements,
> and in the context of a "published page" is really helpful for the
> competent non-expert.
>

I understand your point, but the spec is a guide to the implementers,
rather than developers, and any information there that doesn't help the
implementer is extra weight. The current code examples serve the purpose of
understanding how the API should work and are therefore simple. We'll need
to have more complex code examples, but they should be in a developer
documentation, such as html5rocks or MDN, where you can present the
developer with much more context and informal material. :)

Cheers,
Jussi


> Peter
>
> PS - getting closer to testing out some sysex w/ the Jazz 1.2
> plugin....should be interesting!
>
> On Dec 7, 2012, at 10:48 AM, bugzilla@jessica.w3.org wrote:
>
> > https://www.w3.org/Bugs/Public/show_bug.cgi?id=20254
> >
> > Chris Wilson <cwilso@gmail.com> changed:
> >
> >           What    |Removed                     |Added
> >
> ----------------------------------------------------------------------------
> >           Assignee|dave.null@w3.org            |cwilso@gmail.com
> >
> > --- Comment #2 from Chris Wilson <cwilso@gmail.com> ---
> > (In reply to comment #1)
> >> You might want to break this down a bit after a first pass.
> >
> > Actually, since the API is so simple, I'll probably push in a bunch of
> examples
> > in one go.
> >
> > One question (email response to group is fine) - preferences for inline
> > examples in each section, or separate example section?  I'm leaning
> slightly to
> > the latter.
> >
> > --
> > You are receiving this mail because:
> > You are the QA Contact for the bug.
> >
>
>
>
>