Hi! On 05/07/2008 01:06 PM Derick Rethans wrote: > Hei,
> I've some comments to this as well. > On Wed, 7 May 2008, Alexandru Stanoi wrote: >> - Huge docblock at the beginning of the file is annoying. We should think >> about a way to include docs there. >> + >> +# I prefer to write longer docblocks to help a bit the people who want to >> jump >> + in without reading the tutorial first or asking on IRC. > I agree here, the classes' doc blocks should be informative. Some of the > current ones in many components are quite useles as they don't really > help the users to understand how to use a class. For the @mainclass > classes, they should have a thorough overview including examples. I was not talking about removing the examples from the generated API docs, but to outsource them from the source file. This makes editing the source more convenient and still keeps the informative API docs. >> - ezcFeedTools::getAttributes() is a duplication of >> DOMElement::getAttribute(). >> + >> +# I must have missed that. I will deprecate the function. > Instead of deprecating, can't you just remove it? We've never released > Feed as stable, so we can change the API as much as we want still. That was my intention. Still, you do some weird stuff there. Will look deeper into that later. >> - ezcFeedTools::prepareDate() should not accept DateTime objects. If it >> receives them, this indicates bad code. >> + >> +# What if you assign a DateTime object to $feed->published for example? >> Should >> + the code throw an exception because the date was not a string or >> timestamp? > DateTime objects should be supported here. How is it bad code if it > receives them? If you already have a DateTime object, you should not call this method. Its not good to just call a function and don't actually know what type you currently have. Parsing whatever date value (string or timestamp) is ok, but if you already parsed the date and try to parse it again, that is not good. Regards, Toby -- Mit freundlichen Grüßen / Med vennlig hilsen / With kind regards Tobias Schlitt (GPG: 0xC462BC14) eZ Components Developer [EMAIL PROTECTED] | eZ Systems AS | ez.no -- Components mailing list [email protected] http://lists.ez.no/mailman/listinfo/components
