From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Nick Roberts Newsgroups: gmane.emacs.devel Subject: Documentation of obsolete declarations and aliases. Date: Thu, 5 May 2005 09:05:20 +1200 Message-ID: <17017.14608.787742.440748@farnswood.snap.net.nz> References: <200505040230.j442UFY20511@raven.dms.auburn.edu> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1115252275 32250 80.91.229.2 (5 May 2005 00:17:55 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Thu, 5 May 2005 00:17:55 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu May 05 02:17:53 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1DTU3T-0002pa-OX for ged-emacs-devel@m.gmane.org; Thu, 05 May 2005 02:17:28 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DTUAt-0008Mx-30 for ged-emacs-devel@m.gmane.org; Wed, 04 May 2005 20:25:07 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1DTR6b-0002zP-4J for emacs-devel@gnu.org; Wed, 04 May 2005 17:08:29 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DTR6Z-0002yC-Bv for emacs-devel@gnu.org; Wed, 04 May 2005 17:08:27 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DTR6Y-0002rb-A0 for emacs-devel@gnu.org; Wed, 04 May 2005 17:08:26 -0400 Original-Received: from [202.37.101.8] (helo=viper.snap.net.nz) by monty-python.gnu.org with esmtp (Exim 4.34) id 1DTR8K-0000Kq-KU for emacs-devel@gnu.org; Wed, 04 May 2005 17:10:17 -0400 Original-Received: from farnswood.snap.net.nz (p128-tnt2.snap.net.nz [202.124.108.128]) by viper.snap.net.nz (Postfix) with ESMTP id C31BB4B0918; Thu, 5 May 2005 09:05:10 +1200 (NZST) Original-Received: by farnswood.snap.net.nz (Postfix, from userid 501) id 8C5C362A99; Wed, 4 May 2005 22:05:21 +0100 (BST) Original-To: Luc Teirlinck In-Reply-To: <200505040230.j442UFY20511@raven.dms.auburn.edu> X-Mailer: VM 7.19 under Emacs 22.0.50.37 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:36679 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:36679 > I propose the following doc changes. The main two points are the following. > > Firstly, since the Elisp manual describes the details of how to > declare variables obsolete, should it not also document how to declare > functions obsolete? The patch to lispref/functions.texi does that > with a new node "Obsolete Functions". I described how to declare variables obsolete in the node 'Defining Variables' as defvaralias was described there. The node 'Defining Functions' describes defalias, so that might be a natural place to put your changes. I also suggested a single node called 'Obsoletion' where both sets of changes could go. > ... The documentation also fails to point out that the main > arguments to these macros need to be quoted (which is somewhat > surprising for macros.) I believe that it is better to give a usage > example with expansion, as the patches below do, and refer to the > docstrings of the two functions they combine for details on those two > individual functions. An example seems like a good idea. Nick