From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Juanma Barranquero Newsgroups: gmane.emacs.devel Subject: Re: sit-for arg old-nodisp not documented Date: Sun, 31 Jul 2005 17:11:30 +0200 Message-ID: References: <42EC8331.3050702@student.lu.se> Reply-To: Juanma Barranquero NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: sea.gmane.org 1122824035 1708 80.91.229.2 (31 Jul 2005 15:33:55 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 31 Jul 2005 15:33:55 +0000 (UTC) Cc: Emacs Devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Jul 31 17:33:53 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1DzFp1-0004AG-7B for ged-emacs-devel@m.gmane.org; Sun, 31 Jul 2005 17:33:51 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DzFrc-00026Y-NM for ged-emacs-devel@m.gmane.org; Sun, 31 Jul 2005 11:36:32 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1DzFnJ-00085E-9v for emacs-devel@gnu.org; Sun, 31 Jul 2005 11:32:06 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DzFnB-0007zx-6c for emacs-devel@gnu.org; Sun, 31 Jul 2005 11:31:58 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DzFn7-0007s3-SG for emacs-devel@gnu.org; Sun, 31 Jul 2005 11:31:53 -0400 Original-Received: from [64.233.182.195] (helo=nproxy.gmail.com) by monty-python.gnu.org with esmtp (Exim 4.34) id 1DzFfJ-0001uy-Lo for emacs-devel@gnu.org; Sun, 31 Jul 2005 11:23:49 -0400 Original-Received: by nproxy.gmail.com with SMTP id b2so216479nfe for ; Sun, 31 Jul 2005 08:11:30 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:reply-to:to:subject:cc:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=MJTsA6AK25571adEjm3xkFaoojbu2PCJXCOW2wiypnY9HeCzXlV9Xy6V/rYY2AXpHn/GqrJrp5+fXSjVGA2/+Sb/P9laRj7zw1XHZwphXVCj7JhwIZFA+9ULxUZczUSF/vZz44evbijEPcqbCWDAm6FjU1cugol2HTr5xHHQPvM= Original-Received: by 10.48.250.11 with SMTP id x11mr146544nfh; Sun, 31 Jul 2005 08:11:30 -0700 (PDT) Original-Received: by 10.48.250.5 with HTTP; Sun, 31 Jul 2005 08:11:30 -0700 (PDT) Original-To: Lennart Borgman In-Reply-To: <42EC8331.3050702@student.lu.se> Content-Disposition: inline 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:41372 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:41372 > `sit-for' has an argument old-nodisp that is not described in the doc > string. Not exactly. If you read it again carefully, you'll notice `sit-for' has two modes of invocation: - (modern): (sit-for SECONDS &optional NODISP) - (old): (sit-for SECONDS &optional MILLISECONDS NODISP) So the function is really defined as (sit-for SECONDS &optional NODISP OLD-NODISP) which is accurate, but does not help argument highlighting (MILLISECONDS is not highlighted) and does not match the description (which uses NODISP for the OLD-NODISP argument). The "correct" thing to do would be to define the function (or at least, the docstring) as (sit-for SECONDS &optional NODISP-OR-MILLISECONDS IGNORED-OR-NODISP) but that would be ugly. After the 22.1 release I'll take a deep look at the many docstrings that still have irregularities which are not easy to resolve. I don't want to be forced to add "\(fn ...)" sections to more docstrings (there are already too many, I'd like to remove some), and also don't want to start changing argument names because of dynamic binding issues (sometimes is difficult to see whether an argument is used as a local binding in another function higher in the call stack). --=20 /L/e/k/t/u