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: Re: Incompatible change without "warning" Date: Fri, 22 Apr 2005 10:35:26 +1200 Message-ID: <17000.10926.155798.568572@farnswood.snap.net.nz> References: <16997.28602.876638.54728@farnswood.snap.net.nz> <16998.58339.710430.454702@farnswood.snap.net.nz> <87u0m0rz7f.fsf@xs4all.nl> 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 1114123624 12646 80.91.229.2 (21 Apr 2005 22:47:04 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Thu, 21 Apr 2005 22:47:04 +0000 (UTC) Cc: ich@frank-schmitt.net, rms@gnu.org, Stefan Monnier , emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Apr 22 00:47:01 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1DOkR2-0001b4-CT for ged-emacs-devel@m.gmane.org; Fri, 22 Apr 2005 00:46:13 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DOkVp-0001x6-TW for ged-emacs-devel@m.gmane.org; Thu, 21 Apr 2005 18:51:09 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1DOkUg-0001ZY-UP for emacs-devel@gnu.org; Thu, 21 Apr 2005 18:49:59 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DOkUe-0001ZG-Sf for emacs-devel@gnu.org; Thu, 21 Apr 2005 18:49:58 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DOkUe-0001Hp-PY for emacs-devel@gnu.org; Thu, 21 Apr 2005 18:49:56 -0400 Original-Received: from [202.37.101.8] (helo=viper.snap.net.nz) by monty-python.gnu.org with esmtp (Exim 4.34) id 1DOkVN-0007Ms-7z; Thu, 21 Apr 2005 18:50:41 -0400 Original-Received: from farnswood.snap.net.nz (p177-tnt1.snap.net.nz [202.124.110.177]) by viper.snap.net.nz (Postfix) with ESMTP id C55F34AE408; Fri, 22 Apr 2005 10:47:51 +1200 (NZST) Original-Received: by farnswood.snap.net.nz (Postfix, from userid 501) id EA8D062A99; Thu, 21 Apr 2005 23:35:26 +0100 (BST) Original-To: Lute Kamstra In-Reply-To: <87u0m0rz7f.fsf@xs4all.nl> X-Mailer: VM 7.19 under Emacs 22.0.50.19 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:36257 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:36257 > > Does this DTRT? > > > > (defmacro define-obsolete-variable-alias (symbol aliased > > &optional docstring when) > > "Make SYMBOL a variable alias for symbol ALIASED and warn that > > SYMBOL is obsolete. If provided, WHEN should be a string > > indicating when the variable was first made obsolete, for example > > a date or a release number. Fourth arg docstring, if non-nil, is > > documentation for symbol." > > (list 'progn > > `(defvaralias ,symbol ,aliased ,docstring) > > `(make-obsolete-variable ,symbol ,aliased ,when))) > > The first line of the docstring should be a complete sentence. OK. > Occurrences of argument names in the docstring should be in capitals. > The fourth argument is WHEN, not DOCSTRING. Yes. I changed the argument list but not the docstring. > Personally, I like the > argument names OLDVAR and NEWVAR that XEmacs uses. What about this: I've tried to use the same names from defvaralias and make-obsolete-variable. > (defmacro define-obsolete-variable-alias (oldvar newvar > &optional when docstring) > "Make OLDVAR a variable alias for NEWVAR and warn that OLDVAR is obsolete. > If provided, WHEN should be a string indicating when OLDVAR was > first made obsolete, for example a date or a release number. The > optional argument DOCSTRING specifies the documentation string > for OLDVAR; if it is omitted or nil, OLDVAR uses the documentation > string of NEWVAR" > `(progn > (defvaralias ,oldvar ,newvar ,docstring) > (make-obsolete-variable ,oldvar ,newvar ,when))) Yes, thanks. This is an improvement, but I might stick with my argument names for consistency. Nick