summaryrefslogtreecommitdiff
path: root/doc/ref
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2001-11-18 22:10:41 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2001-11-18 22:10:41 +0000
commit694a9bb34e8c07fa265373876323e5aa30465334 (patch)
tree6ae43435737a1910cc37eac3b36aea22b84253e3 /doc/ref
parent3096b33f0d2984fa602c9943078f078668d3d542 (diff)
downloadguile-694a9bb34e8c07fa265373876323e5aa30465334.tar.gz
* Updates for string- and vector-move-right/left! docstrings.
* Update Tcl war URLs.
Diffstat (limited to 'doc/ref')
-rw-r--r--doc/ref/ChangeLog5
-rwxr-xr-xdoc/ref/scheme-data.texi18
2 files changed, 21 insertions, 2 deletions
diff --git a/doc/ref/ChangeLog b/doc/ref/ChangeLog
index 8236d1649..ed8f871c2 100644
--- a/doc/ref/ChangeLog
+++ b/doc/ref/ChangeLog
@@ -1,3 +1,8 @@
+2001-11-18 Neil Jerram <neil@ossau.uklinux.net>
+
+ * scheme-data.texi (Vectors): Autoupdate docs for
+ vector-move-left! and vector-move-right!.
+
2001-11-16 Neil Jerram <neil@ossau.uklinux.net>
* debugging.texi, deprecated.texi, intro.texi, misc-modules.texi,
diff --git a/doc/ref/scheme-data.texi b/doc/ref/scheme-data.texi
index e8ffd3a81..77e9a654c 100755
--- a/doc/ref/scheme-data.texi
+++ b/doc/ref/scheme-data.texi
@@ -3515,12 +3515,26 @@ returned by @code{vector-fill!} is unspecified.
@deffn {Scheme Procedure} vector-move-left! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_left_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-left!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-left!} copies elements in leftmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-left!} is usually appropriate when
+@var{start1} is greater than @var{start2}.
@end deffn
@deffn {Scheme Procedure} vector-move-right! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_right_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-right!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-right!} copies elements in rightmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-right!} is usually appropriate when
+@var{start1} is less than @var{start2}.
@end deffn
@subsection Vector Selection