1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-28 16:00:22 +02:00

Changed docstrings so that they no longer talk about returning

'pointers' to something.
This commit is contained in:
Marius Vollmer 2004-03-20 23:55:03 +00:00
parent 009c34a2da
commit 71a896390e

View file

@ -1,4 +1,4 @@
/* Copyright (C) 1995,1996,1997,2000,2001, 2003 Free Software Foundation, Inc. /* Copyright (C) 1995,1996,1997,2000,2001, 2003, 2004 Free Software Foundation, Inc.
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public * modify it under the terms of the GNU Lesser General Public
@ -260,7 +260,7 @@ SCM_DEFINE (scm_append_x, "append!", 0, 0, 1,
"A destructive version of @code{append} (@pxref{Pairs and\n" "A destructive version of @code{append} (@pxref{Pairs and\n"
"Lists,,,r5rs, The Revised^5 Report on Scheme}). The cdr field\n" "Lists,,,r5rs, The Revised^5 Report on Scheme}). The cdr field\n"
"of each list's final pair is changed to point to the head of\n" "of each list's final pair is changed to point to the head of\n"
"the next list, so no consing is performed. Return a pointer to\n" "the next list, so no consing is performed. Return\n"
"the mutated list.") "the mutated list.")
#define FUNC_NAME s_scm_append_x #define FUNC_NAME s_scm_append_x
{ {
@ -286,7 +286,7 @@ SCM_DEFINE (scm_append_x, "append!", 0, 0, 1,
SCM_DEFINE (scm_last_pair, "last-pair", 1, 0, 0, SCM_DEFINE (scm_last_pair, "last-pair", 1, 0, 0,
(SCM lst), (SCM lst),
"Return a pointer to the last pair in @var{lst}, signalling an error if\n" "Return the last pair in @var{lst}, signalling an error if\n"
"@var{lst} is circular.") "@var{lst} is circular.")
#define FUNC_NAME s_scm_last_pair #define FUNC_NAME s_scm_last_pair
{ {
@ -344,8 +344,8 @@ SCM_DEFINE (scm_reverse_x, "reverse!", 1, 1, 0,
(SCM lst, SCM new_tail), (SCM lst, SCM new_tail),
"A destructive version of @code{reverse} (@pxref{Pairs and Lists,,,r5rs,\n" "A destructive version of @code{reverse} (@pxref{Pairs and Lists,,,r5rs,\n"
"The Revised^5 Report on Scheme}). The cdr of each cell in @var{lst} is\n" "The Revised^5 Report on Scheme}). The cdr of each cell in @var{lst} is\n"
"modified to point to the previous list element. Return a pointer to the\n" "modified to point to the previous list element. Return the\n"
"head of the reversed list.\n\n" "reversed list.\n\n"
"Caveat: because the list is modified in place, the tail of the original\n" "Caveat: because the list is modified in place, the tail of the original\n"
"list now becomes its head, and the head of the original list now becomes\n" "list now becomes its head, and the head of the original list now becomes\n"
"the tail. Therefore, the @var{lst} symbol to which the head of the\n" "the tail. Therefore, the @var{lst} symbol to which the head of the\n"