[Dev] review of BuildingChandlerParcels

[Ted Leung]

On Nov 29, 2005, at 5:01 PM, Alec Flett wrote:

> Ted -
>  just took a quick pass through this.. it looks good but personally  
> I think it actually has too much detail... I just started (today)  
> rewriting the ZaoBao tutorial, and added lots of detail for issues  
> we ran into during the sprint in the spring (down to the level of  
> "where do I get the build?" and "where do I put this file?") and I  
> think that if this isn't trying to be the tutorial, then we can cut  
> it back even more.
>
> Check out what I have so far, though its no where near as complete  
> as what you've got:
> http://svn.osafoundation.org/chandler/trunk/chandler/distrib/docs/ 
> zaobao-tutorial.html
>
> (someone want to help me with the SVN attributes to make this  
> display as html?)
>
> As a part of that, I've stripped the example down even further than  
> what's in the tree, which means that the overview paper actually  
> has a little more detail than the tutorial itself :)
>
> A few places I think you could cut down:
> 1) schema definitions - I cut them down to look like this:
> class FeedChannel(pim.ListCollection):
>
>     link     = schema.One(schema.URL, displayName=u"RSS Feed URL")
>     category = schema.One(schema.Text)
>     author   = schema.One(schema.Text)
>     date     = schema.One(schema.DateTime)
> I think for the overview you could even leave out the definition of  
> either FeedItem or FeedChannel - I think people will get the idea.

Ok, that's fine.

> 2) the background task stuff is probably way more detailed than it  
> needs to be - I think the basic idea of a class that has a method  
> that gets run on a regular basis is enough

As long as you are going to cover this in detail, I've no problem  
shortening this

>
> 3) I'm working on some diagrams to show how schema.ns works, you  
> probably will want to include them. I hope to have them by the end  
> of tomorrow.

Pictures good.

>
> 4) I think the implementation of  
> FeedControllers.onNewFeedChannelEvent() is probably unnecessary
>
> 5) I wonder if there's a way to scale back the DetailTrunkSubtree  
> stuff.. there's 2 pages of code there that is mostly redundant for  
> each attribute

Are you planning to change the code to reflect these 2 points?  PJE  
also had a code change suggestion -- I was trying to avoid changes  
past the code freeze.

>
> 6) the link to the tutorial at the end just links back to the  
> BuildingChandlerParcels.html document :)

I didn't know the proper location, so waiting for all of that to settle.

>
> Hope that helps...

It definitely does.

Ted

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.osafoundation.org/pipermail/chandler-dev/attachments/20051130/c9f2772d/attachment.htm