From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: dotimes-with-progress-reporter doc string lacks SPEC Date: Fri, 07 Jul 2006 14:02:46 +0300 Message-ID: References: <44AD7613.1060805@student.lu.se> Reply-To: Eli Zaretskii NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1152270194 20006 80.91.229.2 (7 Jul 2006 11:03:14 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 7 Jul 2006 11:03:14 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Jul 07 13:03:12 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Fyo75-0003Mn-6w for ged-emacs-devel@m.gmane.org; Fri, 07 Jul 2006 13:03:11 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Fyo74-0004Lf-9L for ged-emacs-devel@m.gmane.org; Fri, 07 Jul 2006 07:03:10 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Fyo6p-0004KE-Bw for emacs-devel@gnu.org; Fri, 07 Jul 2006 07:02:55 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Fyo6n-0004K2-VT for emacs-devel@gnu.org; Fri, 07 Jul 2006 07:02:54 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Fyo6n-0004Jz-Od for emacs-devel@gnu.org; Fri, 07 Jul 2006 07:02:53 -0400 Original-Received: from [192.114.186.20] (helo=nitzan.inter.net.il) by monty-python.gnu.org with esmtp (Exim 4.52) id 1Fyo7C-0002iP-5t for emacs-devel@gnu.org; Fri, 07 Jul 2006 07:03:18 -0400 Original-Received: from HOME-C4E4A596F7 (IGLD-84-228-163-164.inter.net.il [84.228.163.164]) by nitzan.inter.net.il (MOS 3.7.3-GA) with ESMTP id EAV07711 (AUTH halo1); Fri, 7 Jul 2006 14:02:48 +0300 (IDT) Original-To: Lennart Borgman In-reply-to: <44AD7613.1060805@student.lu.se> (message from Lennart Borgman on Thu, 06 Jul 2006 22:44:03 +0200) 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:56712 Archived-At: > Date: Thu, 06 Jul 2006 22:44:03 +0200 > From: Lennart Borgman > > I think I can guess what the doc string for this function means, but it > would be more easy if SPEC where explicitly explained. Where are you looking, and in what Emacs version? The current doc string for dotimes-with-progress-reporter (see below) mentions all its arguments (SPEC isn't one of them), and it's been like that since January 2005. dotimes-with-progress-reporter is a Lisp macro in `subr.el'. (dotimes-with-progress-reporter (var count [result]) message body...) Loop a certain number of times and report progress in the echo area. Evaluate body with var bound to successive integers running from 0, inclusive, to count, exclusive. Then evaluate result to get the return value (nil if result is omitted). At each iteration message followed by progress percentage is printed in the echo area. After the loop is finished, message followed by word "done" is printed. This macro is a convenience wrapper around `make-progress-reporter' and friends.