[Dev] Feedback on repository documents requested

[Morgen Sagen]

My comments on the "Busy" guide:

In the "Defining Data" section, item3 will have TestAttribute="XYZZY"  
because of the initialValue on that attribute.

In the "parents and children" section, we shouldn't emphasize that you  
can iterate through the children of an item via "for child in item" --  
that method is  dangerous since if the item implements the list methods  
you wont be getting children back from that expression. Instead we  
should use "for child in item.iterChildren():"

In the "Attributes" section, we should mention that  
item.iterAttributes() will give you all attributes, including inherited  
ones (i.e, you don't need to write code to traverse the superKinds  
anymore).

Do you want to mention rep.refresh( ) at all?  Or does that open a can  
of worms leading you to discussing multiple threads, etc?

Also, a link to the Repository API epydoc, especially the 'Item' page (  
http://osafoundation.org/docs/current/api/repository.item.Item.Item- 
class.html ) would be useful.

~morgen

On Oct 12, 2004, at 5:39 PM, Ted Leung wrote:

> Hi all,
>
> I checked in a pair of documents for repository features in 0.4.  I'd  
> appreciate any comments, corrections, or questions regarding their  
> contents.
>
> <http://cvs.osafoundation.org/viewcvs.cgi/*checkout*/chandler/distrib/ 
> docs/repository-intro.html?rev=HEAD&content-type=text/html>
>
> <http://cvs.osafoundation.org/viewcvs.cgi/*checkout*/chandler/distrib/ 
> docs/chandler-query-system.html?rev=HEAD&content-type=text/html>
>
> Thanks,
>
> Ted
>
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "Dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/dev