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: Sun, 28 Nov 2010 16:01:11 -0500 Message-ID: References: <9166F5772B0D414D84ECE3808ECD3964@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1290978912 5412 80.91.229.12 (28 Nov 2010 21:15:12 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sun, 28 Nov 2010 21:15:12 +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 Sun Nov 28 22:15:08 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 1PMoaM-0004OV-BI for geb-bug-gnu-emacs@m.gmane.org; Sun, 28 Nov 2010 22:15:03 +0100 Original-Received: from localhost ([127.0.0.1]:55684 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PMoaL-0002Dt-MT for geb-bug-gnu-emacs@m.gmane.org; Sun, 28 Nov 2010 16:15:01 -0500 Original-Received: from [140.186.70.92] (port=53483 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PMoaG-0002DV-2H for bug-gnu-emacs@gnu.org; Sun, 28 Nov 2010 16:14:57 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PMoaF-0007Nz-3Z for bug-gnu-emacs@gnu.org; Sun, 28 Nov 2010 16:14:56 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:35782) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PMoaF-0007Np-1m for bug-gnu-emacs@gnu.org; Sun, 28 Nov 2010 16:14:55 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1PMoHy-0007c3-Al; Sun, 28 Nov 2010 15:56: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: Sun, 28 Nov 2010 20:56: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.129097774729237 (code B ref 7509); Sun, 28 Nov 2010 20:56:02 +0000 Original-Received: (at 7509) by debbugs.gnu.org; 28 Nov 2010 20:55:47 +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 1PMoHi-0007bW-J1 for submit@debbugs.gnu.org; Sun, 28 Nov 2010 15:55:47 -0500 Original-Received: from chene.dit.umontreal.ca ([132.204.246.20]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1PMoHe-0007bI-8d for 7509@debbugs.gnu.org; Sun, 28 Nov 2010 15:55:43 -0500 Original-Received: from pastel.home (lechon.iro.umontreal.ca [132.204.27.242]) by chene.dit.umontreal.ca (8.14.1/8.14.1) with ESMTP id oASL1CvW030278; Sun, 28 Nov 2010 16:01:12 -0500 Original-Received: by pastel.home (Postfix, from userid 20848) id 786A6A85F1; Sun, 28 Nov 2010 16:01:11 -0500 (EST) In-Reply-To: <9166F5772B0D414D84ECE3808ECD3964@us.oracle.com> (Drew Adams's message of "Sun, 28 Nov 2010 11:42:46 -0800") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) X-NAI-Spam-Score: 0 X-NAI-Spam-Rules: 1 Rules triggered RV3693=0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Sun, 28 Nov 2010 15:56: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:41983 Archived-At: > 1. User option `comment-style' should be documented in the Emacs manual. Indeed. It probably doesn't need to be in the Elisp manual, but the User manual should mention it. > 2. The doc string of `comment-style' should explain what each of the > possible values is/does. It should not refer you to the doc string for > `comment-styles' (a defconst). >From a modularity point of view, this is somewhat problematic. So I have philosophical problems with this, although I agree that the current docstring doesn't work well in Custom. Maybe a solution is to extend comment-styles so it includes a short docstring for each entry that can then be used for the label on each value in the "Value menu" of comment-style. > 3. The doc string of `comment-styles' is anyway out of date. Not all of > the values are described. This means that users trying to customize > `comment-style' are lost. I don't understand: the docstring of comment-styles (like all other variable docstrings) doesn't describe its current value, but rather what are its possible value(s) and what they mean. It seems to be just as up-to-date as when I originally wrote it (that part of the code hasn't changed since, AFAIK). Stefan