From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: lists.texi Date: Sat, 18 Jun 2005 18:19:32 -0500 (CDT) Message-ID: <200506182319.j5INJWF08937@raven.dms.auburn.edu> NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1119136952 18103 80.91.229.2 (18 Jun 2005 23:22:32 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 18 Jun 2005 23:22:32 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Jun 19 01:22:31 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Djmdb-00065r-0s for ged-emacs-devel@m.gmane.org; Sun, 19 Jun 2005 01:22:07 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DjmjV-0000uL-2L for ged-emacs-devel@m.gmane.org; Sat, 18 Jun 2005 19:28:13 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Djmiq-0000t8-VT for emacs-devel@gnu.org; Sat, 18 Jun 2005 19:27:33 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Djmin-0000rR-Fq for emacs-devel@gnu.org; Sat, 18 Jun 2005 19:27:30 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Djmin-0000rA-Dk for emacs-devel@gnu.org; Sat, 18 Jun 2005 19:27:29 -0400 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.34) id 1Djmeh-0006h6-0E for emacs-devel@gnu.org; Sat, 18 Jun 2005 19:23:15 -0400 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id j5INKrCK015031 for ; Sat, 18 Jun 2005 18:20:53 -0500 (CDT) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.7p1+Sun/8.11.7) id j5INJWF08937; Sat, 18 Jun 2005 18:19:32 -0500 (CDT) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: emacs-devel@gnu.org 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:39089 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:39089 I recommend the following changes to lists.texi and can install if desired. In as far as spelling issues are concerned, `vs' seems to be the standard abbreviation of `versus' and `indices' seems to be the plural form of `index' consistently used in the Elisp manual. In as far as the return value of `ring-insert-at-beginning' is concerned, it definitely is _not_ OBJECT as currently documented in the Elips manual. The return value is the _new_ length of the ring, but this seems to be by accident, rather than by design. We could either document the actual return value, change `ring-insert-at-beginning' to really return OBJECT (does not seem terribly useful to me) or say that the return value is not significant. The patch below does the latter. ===File ~/lists.texi-diff=================================== *** lists.texi 17 Jun 2005 09:08:29 -0500 1.52 --- lists.texi 18 Jun 2005 16:58:45 -0500 *************** *** 715,721 **** primitives @code{setcar} and @code{setcdr}. We call these ``destructive'' operations because they change existing list structure. ! @cindex CL note---@code{rplaca} vrs @code{setcar} @quotation @findex rplaca @findex rplacd --- 715,721 ---- primitives @code{setcar} and @code{setcdr}. We call these ``destructive'' operations because they change existing list structure. ! @cindex CL note---@code{rplaca} vs @code{setcar} @quotation @findex rplaca @findex rplacd *************** *** 1691,1697 **** @end defun @defun ring-p object ! This returns @code{t} if @var{object} is a ring. @end defun @defun ring-size ring --- 1691,1697 ---- @end defun @defun ring-p object ! This returns @code{t} if @var{object} is a ring, @code{nil} otherwise. @end defun @defun ring-size ring *************** *** 1705,1725 **** @defun ring-elements ring This returns a list of the objects in @var{ring}, in no particular ! order. @end defun @defun ring-copy ring This returns a new ring which is a copy of @var{ring}. ! The new ring contains the same objects as @var{ring}. @end defun @defun ring-empty-p ring ! This returns @code{t} if @var{ring} is empty. @end defun ! The newest element in the ring always has index 0. Higher indexes ! correspond to older elements. Index @minus{}1 corresponds to the ! oldest element, @minus{}2 to the next-oldest, and so forth. @defun ring-ref ring index This returns the object in @var{ring} found at index @var{index}. --- 1705,1728 ---- @defun ring-elements ring This returns a list of the objects in @var{ring}, in no particular ! order. The length of that list is always the ring size. If the ring ! length is less than the ring size, the entries of the list that do not ! correspond to ring elements are @code{nil}. @end defun @defun ring-copy ring This returns a new ring which is a copy of @var{ring}. ! The new ring contains the same (@code{eq}) objects as @var{ring}. @end defun @defun ring-empty-p ring ! This returns @code{t} if @var{ring} is empty, @code{nil} otherwise. @end defun ! The newest element in the ring always has index 0. Higher indices ! correspond to older elements. Indices are computed modulo the ring ! length. Index @minus{}1 corresponds to the oldest element, @minus{}2 ! to the next-oldest, and so forth. @defun ring-ref ring index This returns the object in @var{ring} found at index @var{index}. *************** *** 1744,1750 **** @defun ring-insert-at-beginning ring object This inserts @var{object} into @var{ring}, treating it as the oldest ! element, and returns @var{object}. If the ring is full, this function removes the newest element to make room for the inserted element. --- 1747,1753 ---- @defun ring-insert-at-beginning ring object This inserts @var{object} into @var{ring}, treating it as the oldest ! element. The return value is not significant. If the ring is full, this function removes the newest element to make room for the inserted element. ============================================================