From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: storm@cua.dk (Kim F. Storm) Newsgroups: gmane.emacs.devel Subject: Re: `whitespace-describe' function missing Date: 14 Apr 2003 17:23:36 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <5xfzolxfuv.fsf@kfs2.cua.dk> References: NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: main.gmane.org 1050326710 22711 80.91.224.249 (14 Apr 2003 13:25:10 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Mon, 14 Apr 2003 13:25:10 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Mon Apr 14 15:25:09 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1953xM-0005u9-00 for ; Mon, 14 Apr 2003 15:25:08 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian)) id 1953yk-0003nO-00 for ; Mon, 14 Apr 2003 15:26:34 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 1953xf-0004rH-00 for emacs-devel@quimby.gnus.org; Mon, 14 Apr 2003 09:25:27 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.10.13) id 1953xF-0004q7-00 for emacs-devel@gnu.org; Mon, 14 Apr 2003 09:25:01 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.10.13) id 1953xE-0004pj-00 for emacs-devel@gnu.org; Mon, 14 Apr 2003 09:25:00 -0400 Original-Received: from mail.filanet.dk ([195.215.206.179]) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 1953xD-0004pB-00; Mon, 14 Apr 2003 09:24:59 -0400 Original-Received: from kfs2.cua.dk.cua.dk (kfs2.local.filanet.dk [192.168.1.182]) by mail.filanet.dk (Postfix) with SMTP id 403897C012; Mon, 14 Apr 2003 15:24:58 +0200 (CEST) Original-To: bob@rattlesnake.com In-Reply-To: Original-Lines: 48 User-Agent: Gnus/5.09 (Gnus v5.9.0) Emacs/21.3.50 Original-cc: rv@gnu.org X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1b5 Precedence: list List-Id: Emacs development discussions. List-Help: List-Post: List-Subscribe: , List-Archive: List-Unsubscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:13225 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:13225 "Robert J. Chassell" writes: > (whitespace-describe): Remove. Move the text to `Commentary:'. IMO, it doesn't really make sense to have a function which produces the help for a given package, as there sufficient other ways to provide that information (BTW printing.el is another package which does this). In any case, when the source file has valuable inforation in the commentary section, there should at least be a Commentary link on the customization section for whitespace-global-mode; I believe one can be added to the define-minor-mode as :link '(emacs-commentary-link :tag "Commentary" "whitespace.el") but I haven't tried it. > Incidentally, while you could re-include your function definition of > `whitespace-describe' in the CVS, it is surprising to see > documentation like that. I would expect to see the full documentation > in the documentation strings of: > > whitespace-buffer > whitespace-region > whitespace-cleanup > > as well as in the commentary and in the Texinfo documentation. Maybe we could find a way to make commentary links from doc strings to the lisp file? E.g. with an extra button like "See also" ... | whitespace-global-mode's value is nil | | Non-nil if Whitespace-Global mode is enabled. | See the command `whitespace-global-mode' for a description of this minor-mode. | Setting this variable directly does not take effect; | use either M-x customize or the function `whitespace-global-mode'. + + See also _Commentary_ | | You can customize this variable. | | Defined in `whitespace'. -- Kim F. Storm http://www.cua.dk