Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el (describe-mode): Return nil (for IELM's sake).

Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el (describe-mode): Return nil (for IELM's sake).

[Stefan Monnier]

>   * help.el (describe-mode): Return nil (for IELM's sake).
[..]
> -	(princ (documentation major-mode))))))
> +	(princ (documentation major-mode)))))
> +  nil)
 
Here's a prime example of what I sent yesterday: if you think about it,
the "for IELM's sake" part of the comment would be very welcome in the
code, so that's where it should be instead of in the ChangeLog.


        Stefan

Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el (describe-mode): Return nil (for IELM's sake).

[Juanma Barranquero]

On Mon, Apr 5, 2010 at 15:55, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

> Here's a prime example of what I sent yesterday: if you think about it,
> the "for IELM's sake" part of the comment would be very welcome in the
> code, so that's where it should be instead of in the ChangeLog.

Hm, I'm not sure. I changed it for IELM's sake, but any code that
calls the function and returns its result is going to benefit from it.
There's nothing *specifically* IEMLy in returning nil.

    Juanma

Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el

[Stefan Monnier]

>> Here's a prime example of what I sent yesterday: if you think about it,
>> the "for IELM's sake" part of the comment would be very welcome in the
>> code, so that's where it should be instead of in the ChangeLog.
> Hm, I'm not sure. I changed it for IELM's sake, but any code that
> calls the function and returns its result is going to benefit from it.
> There's nothing *specifically* IEMLy in returning nil.

That's a problem of the comment itself, not of where it's placed.
My argument is only that it should go in a comment rather than in
the ChangeLog.


        Stefan


PS: And even if it can be useful in other circumstances it's still
useful to explain which circumstance prompted the reaction.  So if you
really insist you could say "for the sake of IELM and maybe others".

Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el

[Juanma Barranquero]

On Mon, Apr 5, 2010 at 21:31, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

> That's a problem of the comment itself, not of where it's placed.

No, the comment is accurately describing why I did the change. But
it's not worth discussing this; I'll change it.

> PS: And even if it can be useful in other circumstances it's still
> useful to explain which circumstance prompted the reaction.  So if you
> really insist you could say "for the sake of IELM and maybe others".

OK.

    Juanma

Re: [Emacs-diffs] /srv/bzr/emacs/trunk r99829: * help.el

[Stefan Monnier]

>> That's a problem of the comment itself, not of where it's placed.
> No, the comment is accurately describing why I did the change.

Then, there's no need to change its content, only its place.

> But it's not worth discussing this;

If you're talking about discussing the comment's content, I fully agree.
All I'm interested in is discussing the comment's *place*, which in this
case should be in the code rather than (or additionally to) in
the ChangeLog.

> I'll change it.

I don't care too much about this part, actually.  But feel free to
change it if you feel like it.


        Stefan