From: Luc Teirlinck <teirllm@dms.auburn.edu>
Subject: lists.texi
Date: Sat, 18 Jun 2005 18:19:32 -0500 (CDT) [thread overview]
Message-ID: <200506182319.j5INJWF08937@raven.dms.auburn.edu> (raw)
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.
============================================================
next reply other threads:[~2005-06-18 23:19 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-06-18 23:19 Luc Teirlinck [this message]
2005-06-19 0:01 ` lists.texi Luc Teirlinck
2005-06-19 0:15 ` lists.texi Luc Teirlinck
2005-06-19 0:37 ` lists.texi Luc Teirlinck
2005-06-19 6:37 ` lists.texi David Kastrup
2005-06-19 15:55 ` lists.texi Richard Stallman
2005-06-19 17:47 ` lists.texi Luc Teirlinck
2005-06-20 17:52 ` lists.texi Richard Stallman
2005-06-20 23:12 ` lists.texi Luc Teirlinck
2005-06-21 5:13 ` lists.texi David Kastrup
2005-06-21 15:13 ` lists.texi Richard M. Stallman
2005-06-21 16:35 ` lists.texi Thien-Thi Nguyen
2005-06-21 19:00 ` lists.texi Luc Teirlinck
2005-06-21 21:56 ` lists.texi Thien-Thi Nguyen
2005-06-21 19:45 ` lists.texi Luc Teirlinck
2005-06-21 20:58 ` lists.texi Luc Teirlinck
2005-06-21 22:09 ` lists.texi Thien-Thi Nguyen
2005-06-22 16:28 ` lists.texi Juri Linkov
2005-06-22 19:27 ` lists.texi Eli Zaretskii
2005-06-22 18:44 ` lists.texi Luc Teirlinck
2005-06-22 20:25 ` lists.texi Luc Teirlinck
2005-06-23 16:53 ` lists.texi Richard M. Stallman
2005-06-24 19:02 ` GC (was: lists.texi) Juri Linkov
2005-06-24 19:02 ` Juri Linkov
2005-06-24 21:08 ` Eli Zaretskii
2005-06-24 21:54 ` Juri Linkov
2005-06-24 23:52 ` Luc Teirlinck
2005-06-25 0:51 ` Miles Bader
2005-06-25 9:48 ` Eli Zaretskii
2005-06-25 11:58 ` GC Adrian Aichner
2005-06-25 12:53 ` GC Miles Bader
2005-06-25 21:53 ` GC Adrian Aichner
2005-06-26 0:02 ` GC Miles Bader
2005-06-26 8:20 ` GC Adrian Aichner
2005-06-26 18:51 ` GC Eli Zaretskii
2005-06-26 23:43 ` GC Juri Linkov
2005-06-27 5:38 ` GC Richard M. Stallman
2005-06-26 22:42 ` GC Richard M. Stallman
2005-06-25 12:15 ` GC (was: lists.texi) Miles Bader
2005-06-25 13:10 ` GC Gaëtan LEURENT
2005-06-25 14:48 ` GC Eli Zaretskii
2005-06-25 14:45 ` GC (was: lists.texi) Eli Zaretskii
2005-06-25 16:40 ` Richard M. Stallman
2005-06-28 4:55 ` GC Stefan Monnier
2005-06-28 21:29 ` GC Richard M. Stallman
2005-07-11 17:00 ` GC Stefan Monnier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=200506182319.j5INJWF08937@raven.dms.auburn.edu \
--to=teirllm@dms.auburn.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).