On Thu, Mar 06, 2003 at 05:37:29AM +0000, John Levon wrote:
> There is a checkbox "Use AMS Math" in the doc setup (or prefs, I
> forget).
> 
> Why this isn't "Automatically use AMS math package", default selected, I
> do not know.

Because I don't know where I can switch this on by default. If I knew, this
would be in.

I know I am risking getting flamed from someone here.

> *sigh*. Don't ask... the theory is that people will add comments saying
> what the method does. The reality is: nothing happens.

I have about 35% of the methods commented, and for the
"usual suspects" at least the base class method are commented.

> We need to make a decision concerning documentation of inherited
> methods.

That's a problem indeed.

> My preference :
> 
> 1) method is trivially described by its name - no "///" no "///
> validates", no anything.
> 
> 2) method acts the same as its superclass's (transitively), with no
> significant API difference - no comment.
> 
> 3) method is introduced at this point in the hierarchy - add a comment
> 
> 4) method behaves somehow differently or something needs pointing out
> for a derived method - add a comment

Would be fine with me although I got used to the two-line-pattern in .h

Andre'

-- 
Those who desire to give up Freedom in order to gain Security,
will not have, nor do they deserve, either one. (T. Jefferson)

Reply via email to