Re: Undocumented hyperlinks in doc strings.

[Luc Teirlinck <teirllm@dms.auburn.edu>]

Richard Stallman wrote:

   That might be a good solution.  However, users won't all
   remember to do it manually.  Is there a way to make comment-region
   decide this automatically?

Currently, comment-region inserts, by default, in emacs-lisp-mode, two
semicolons and one space at the margin.  With the current convention,
one has to remember to give it a numeric argument of 3 when commenting
out code.  With the proposed new convention, that would only be
necessary when commenting out code _inside_ a function.  Apart from
that the only extra thing to remember would be to leave the extra one
space for the introductory: "this used: " type of sentence, if
present.  I guess it might be feasible to make comment-region insert
three semicolons by default when commenting out code _inside_ a
function with semicolons at the margin (since with two semicolons
C-M-q would mess things up in this situation), but even without that I
believe that comment-region in its present form would interact better
with the new proposed convention that with the current one (because an
explicit numeric argument would be needed less often).

Sincerely,

Luc.