Hi,
we managed to overwork the YAML design document according to the feedback we
got. The API is straightened and we added a part about the main classes.
You can find the document at
http://svn.ez.no/svn/ezcomponents/experimental/Yaml/design/design.txt
Please have a look at it. There are still some questions left marked as @TODO.
Would be nice to here your opinion about it.
Thanks in advance
Thomas
Am Dienstag, 31. März 2009 10:31:14 schrieb Derick Rethans:
> Hei!
>
> On Fri, 27 Mar 2009, Thomas Nunninger wrote:
> > As it seemed that not everybody knows what YAML is about first a short
> > overview: YAML is a format to serialize data structures from
> > programming languages to plain text. The style is somehow like XML
> > without the "<" and ">" - ordering is done via line indention. The
> > main usage are configuration files (e.g. symfony uses them; and it
> > seems to be much more used in the Python world). But YAML is not
> > limited to configuration files. You can use it as simple exchange
> > format between software systems, log file format and much more.
> >
> > Unfortunately it took longer than expected to write the design
> > document. Find the updated requirements.txt (related to the feedback
> > we got on the list) and the design.txt on
> >
> > http://svn.ez.no/svn/ezcomponents/experimental/Yaml/design/
>
> Just to summarize the things we discussed on IRC yesterday:
>
> 1. I suggested to not use the words Dumper and ->dump() but instead use
> Generator and ->generate(). Thomas explained that those terms come
> from the YAML spec, however, I think we should pick sensible names
> that are according to our own guidelines instead.
>
> 2. I mentioned I wasn't a fan of the requirement of having to set a
> callback to finish a document. This only happens in the low-level API
> which we sort of decided to mark as private. As long as the code will
> work without having to *set* any options by default, I'm now fine
> with this.
>
> 3. I asked for clarification on how to handle the different YAML
> versions, and how to do that in the code. If I remember correctly,
> you will add some text to the document for this?
>
> > Till now we mainly concentrated on the usage of the component. We
> > planned to write some more details about the classes. But as this
> > would have taken some more time and we wanted to ask for your feedback
> > at the current state, we left it out till now.
>
> We've also discussed that part, and I suggested you add atleast some
> information about the major classes.
>
> with kind regards,
> --
> Derick Rethans
> eZ components Product Manager
> eZ systems | http://ez.no
--
Thomas Nunninger
Steinhalde 108
79117 Freiburg
Tel.: 0761 1201850
Mobil: 0163 7115153
http://nunninger.info
USt-IdNr: DE259832548
--
Components mailing list
Components@lists.ez.no
http://lists.ez.no/mailman/listinfo/components
