On Jan 12, 2008, at 2:56 PM, Dmitry Kandalov wrote:
On Saturday 12 January 2008 23:25:43 Igor Vaynberg wrote:
sure, and all you need to know is that you subclass
requestcycle.onbeginrequest() and add your own code there and it is
called at the beginning of the request. why do you need to know the
sequence of calls that leads to onbeginrequest() being called?

I don't. I can image someone may want to be sure that this method is called before anything else he overrides, or to know that he can't get requested
page at this step, but probably it's a very rare case.

I've hit exactly this type of issue -- you try to override one of the public methods, and it turns out that the object isn't fully initialized yet, so you can't do what you'd hoped to.

I agree there's value to the black-box model, data encapsulation, and all that -- I don't want to know all the gory details of your implementation. However, for public methods which are designed to be overridden when necessary, it would be extremely helpful to have more documentation provided about the state of the object when that method is called.

It's a matter of balance -- overall I think the documentation is pretty good, but there are places where it's weaker than it should be. Yes, I can set breakpoints and step through the code, but that shouldn't be the default response to questions about missing documentation. Following that argument you could say that NO javadocs are ever necessary :)

Thanks for all the great work,
Alex

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to