GNU bug report logs - #3371
23.0.94; doc of `comment-style'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 3371 in the body.
You can then email your comments to 3371 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <emacs-pretest-bug <at> gnu.org>
Subject: 23.0.94; doc of `comment-style'
Date: Sun, 24 May 2009 19:09:02 -0700

Doc string:
 
"Style to be used for `comment-region'.
See `comment-styles' for a list of available styles."
 
1. Put the available styles here.
 
2. There is no such function or variable as `comment-styles'.
 
3. `comment-style' is mentioned in neither the Emacs manual nor the
Elisp manual.
 
IOW, there is really no doc explaining what this is, what it does, or
how it does it.
 
 
 
In GNU Emacs 23.0.94.1 (i386-mingw-nt5.1.2600)
 of 2009-05-24 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 

Message #10 received at 3371 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: Drew Adams <drew.adams <at> oracle.com>, 3371 <at> debbugs.gnu.org
Subject: Re: bug#3371: 23.0.94; doc of `comment-style'
Date: Mon, 25 May 2009 09:04:35 +0200

[Message part 1 (text/plain, inline)]

> "Style to be used for `comment-region'.
> See `comment-styles' for a list of available styles."
>
> 1. Put the available styles here.
>
> 2. There is no such function or variable as `comment-styles'.

We probably could add two autoload cookies to newcomment.el (I don't
recall why I wanted the one for `comment-empty-lines' once).

martin

[newcomment.el.diff (text/plain, inline)]

*** newcomment.el.~1.116.~	2009-01-05 09:59:16.000000000 +0100
--- newcomment.el	2009-05-25 08:36:37.000000000 +0200
***************
*** 185,190 ****
--- 185,191 ----
  This should generally stay 0, except for a few modes like Lisp where
  it is 1 so that regions are commented with two or three semi-colons.")
  
+ ;;;###autoload
  (defconst comment-styles
    '((plain	. (nil nil nil nil))
      (indent	. (nil nil nil t))
***************
*** 240,245 ****
--- 241,247 ----
    :type 'boolean
    :group 'comment)
  
+ ;;;###autoload
  (defcustom comment-empty-lines nil
    "If nil, `comment-region' does not comment out empty lines.
  If t, it always comments out empty lines.
***************
*** 1232,1238 ****
                               (buffer-substring (point)
                                                 (progn (move-to-left-margin)
                                                        (point)))))))))))))
!                     
  
  ;;;###autoload
  (defun comment-indent-new-line (&optional soft)
--- 1234,1240 ----
                               (buffer-substring (point)
                                                 (progn (move-to-left-margin)
                                                        (point)))))))))))))
! 
  
  ;;;###autoload
  (defun comment-indent-new-line (&optional soft)

Message #15 received at 3371 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: martin rudalics <rudalics <at> gmx.at>
Cc: 3371 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#3371: 23.0.94; doc of `comment-style'
Date: Mon, 25 May 2009 09:44:05 -0400

> We probably could add two autoload cookies to newcomment.el (I don't
> recall why I wanted the one for `comment-empty-lines' once).

I'd much rather remove the one on comment-style.


        Stefan

Message #20 received at 3371 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: martin rudalics <rudalics <at> gmx.at>, 3371 <at> debbugs.gnu.org,
        Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#3371: 23.0.94; doc of `comment-style'
Date: Mon, 25 May 2009 23:34:18 -0400

> > We probably could add two autoload cookies to newcomment.el (I don't
> > recall why I wanted the one for `comment-empty-lines' once).
>
> I'd much rather remove the one on comment-style.

But the comment-region docstring refers to it.

Message #25 received at 3371 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3371 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#3371: 23.0.94; doc of `comment-style'
Date: Tue, 26 May 2009 11:29:16 +0200

>> We probably could add two autoload cookies to newcomment.el (I don't
>> recall why I wanted the one for `comment-empty-lines' once).
>
> I'd much rather remove the one on comment-style.

This is an option so `comment-styles' will show up anyway when people
customize `comment-style'.  Nothing won't stop people from using a
comment style you dislike personally.  The more you hide things like
`comment-styles' the more they become some sort of a forbidden fruit.

martin

Message #30 received at 3371 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: martin rudalics <rudalics <at> gmx.at>
Cc: 3371 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#3371: 23.0.94; doc of `comment-style'
Date: Tue, 26 May 2009 13:06:51 -0400

>>> We probably could add two autoload cookies to newcomment.el (I don't
>>> recall why I wanted the one for `comment-empty-lines' once).
>> I'd much rather remove the one on comment-style.
> This is an option so `comment-styles' will show up anyway when people
> customize `comment-style'.  Nothing won't stop people from using a
> comment style you dislike personally.  The more you hide things like
> `comment-styles' the more they become some sort of a forbidden fruit.

I don't want to hide comment-styles.
I just don't like autoloading variables.

Of course, in this particular case, my favorite choice has always been
to preload newcomment.el.


        Stefan

Message #35 received at 3371 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 3371 <at> debbugs.gnu.org
Subject: Re: 23.0.94; doc of `comment-style'
Date: Mon, 11 Jul 2011 18:07:08 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> "Style to be used for `comment-region'.
> See `comment-styles' for a list of available styles."
>
> 1. Put the available styles here.
>
> 2. There is no such function or variable as `comment-styles'.

`comment-styles' is defined in Emacs 24, at least, and has the list of
the styles.

> 3. `comment-style' is mentioned in neither the Emacs manual nor the
> Elisp manual.
>
> IOW, there is really no doc explaining what this is, what it does, or
> how it does it.

`comment-region' links to it, which I think is sufficient for people to
discover it if they want to customize `comment-region'.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.