[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Undocumented hyperlinks in doc strings.

From: Luc Teirlinck
Subject: Re: Undocumented hyperlinks in doc strings.
Date: Wed, 15 Oct 2003 18:52:29 -0500 (CDT)

Richard Stallman wrote:

   It is not unusual to comment out code that was replaced.
   Whether it is worth keeping depends on details.  Maybe it would
   be just as well to delete that comment, but I would not say all
   such comments should always be deleted.

Is this commenting out instead of deletion done for historical record
or because one was not sure about the change and because hence there
is the possibility that one might want to sooner or later revert to
the original code?  If the former, one could keep the code in
question, after maybe pointing out more clearly that the code was the
old alternative to 'help-function-def.  Otherwise, the
`define-button-type' for 'help-function-def contains a modified
version of that code, with a comment explaining why that modification
was necessary.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]