From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.bugs Subject: bug#7509: 24.0.50; doc for `comment-style' and `comment-styles' Date: Tue, 30 Nov 2010 21:57:08 -0500 Message-ID: References: <9166F5772B0D414D84ECE3808ECD3964@us.oracle.com> <27E6B536A09248629C372671995E7E97@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: dough.gmane.org 1291184419 23104 80.91.229.12 (1 Dec 2010 06:20:19 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Wed, 1 Dec 2010 06:20:19 +0000 (UTC) Cc: 7509@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Dec 01 07:20:15 2010 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1PNg34-0003lR-Ar for geb-bug-gnu-emacs@m.gmane.org; Wed, 01 Dec 2010 07:20:15 +0100 Original-Received: from localhost ([127.0.0.1]:46351 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PNg33-0007E7-Aj for geb-bug-gnu-emacs@m.gmane.org; Wed, 01 Dec 2010 01:20:13 -0500 Original-Received: from [140.186.70.92] (port=53435 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PNd9x-0002Mx-Qu for bug-gnu-emacs@gnu.org; Tue, 30 Nov 2010 22:15:16 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PNd9r-0006qB-93 for bug-gnu-emacs@gnu.org; Tue, 30 Nov 2010 22:15:09 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:36469) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PNd9r-0006pt-77 for bug-gnu-emacs@gnu.org; Tue, 30 Nov 2010 22:15:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1PNcna-0004OU-7V; Tue, 30 Nov 2010 21:52:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 01 Dec 2010 02:52:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 7509 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 7509-submit@debbugs.gnu.org id=B7509.129117189516853 (code B ref 7509); Wed, 01 Dec 2010 02:52:02 +0000 Original-Received: (at 7509) by debbugs.gnu.org; 1 Dec 2010 02:51:35 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1PNcn8-0004Nm-59 for submit@debbugs.gnu.org; Tue, 30 Nov 2010 21:51:34 -0500 Original-Received: from ironport2-out.teksavvy.com ([206.248.154.183] helo=ironport2-out.pppoe.ca) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1PNcn5-0004Na-AB for 7509@debbugs.gnu.org; Tue, 30 Nov 2010 21:51:32 -0500 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AvcIABlI9UxMCqFw/2dsb2JhbACDUJ46gQRyswqQb4EhgzNzBIRcOI03 X-IronPort-AV: E=Sophos;i="4.59,282,1288584000"; d="scan'208";a="84189887" Original-Received: from 76-10-161-112.dsl.teksavvy.com (HELO ceviche.home) ([76.10.161.112]) by ironport2-out.pppoe.ca with ESMTP/TLS/ADH-AES256-SHA; 30 Nov 2010 21:57:08 -0500 Original-Received: by ceviche.home (Postfix, from userid 20848) id 42FF3660DC; Tue, 30 Nov 2010 21:57:08 -0500 (EST) In-Reply-To: <27E6B536A09248629C372671995E7E97@us.oracle.com> (Drew Adams's message of "Tue, 30 Nov 2010 14:36:41 -0800") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Tue, 30 Nov 2010 21:52:02 -0500 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:42027 Archived-At: >> There's no such magic. > Are you saying that `makunbound' should take care of it? No. I'm saying that there is no known trick to undo a defcustom. > Also, it wouldn't hurt to include such tiny diagrams in the doc string > for `comment-styles' (esp. since it is a defconst). In this case, > a set of pictures is worth more than a set of one-liner descriptions. Again, that would amount to documenting the particular current value of that variable, rather than the set of possible values and their meaning. So that would be wrong. Such documentation can't belong to comment-styles's docstring; only to the doc of each style defined there. > BTW, why are all of the various possibilities (align, extra, box etc.) > defined only for indented comments? The only reason `plain' exists is because that's what was used in Emacs=E2=89=A422. I strongly discourage people from using it since it often results in comments that aren't properly indented. > plain - Start in column 0 (do not indent) > indent - Full comment per line, ends not aligned > aligned - Full comment per line, ends aligned > box - Full comment per line, ends aligned, + top and bottom > extra-line - One comment for all lines, end on a line by itself > multi-line - One comment for all lines, end on last commented line > box-multi - One comment for all lines, + top and bottom Thanks, that seems much better than what I have now. Stefan