doco deprecated substring-move-left! and right!

* doco deprecated substring-move-left! and right!
@ 2003-05-23 22:03 Kevin Ryde
  2003-05-30  0:12 ` Kevin Ryde
  0 siblings, 1 reply; 2+ messages in thread
From: Kevin Ryde @ 2003-05-23 22:03 UTC (permalink / raw)


[-- Attachment #1: Type: text/plain, Size: 1151 bytes --]

I think it'd be good to have all superceded functions appear in the
deprecated chapter of the manual.  It can say what they do, for the
benefit of anyone seeing them in old code, and can explain what
they've been replaced by or what was wrong with them.  As a bit of a
start:

	* deprecated.texi: Add substring-move-left! and substring-move-right!.


Deprecated
**********

The features and functions described in this chapter are considered
obsolete and should not be used by new programs.  They're retained for
compatibility with past versions of Guile.

 - Scheme Procedure: substring-move-left! str1 start1 end1 str2 start2
 - Scheme Procedure: substring-move-right! str1 start1 end1 str2 start2
     These functions are aliases for `substring-move!' and calls to
     them can simply be replaced by `substring-move!' (*note String
     Modification::.)

     In the past, if STR1 and STR2 were the same string, it was
     necessary to call `substring-move-left!' if the move was to the
     left (START2 < START1), or call `substring-move-right!' if the
     move was to the right (START2 > START1).  `substring-move!' is able
     to do both.


[-- Attachment #2: deprecated.texi.substring-move.diff --]
[-- Type: text/plain, Size: 1040 bytes --]

--- deprecated.texi.~1.3.~	2002-03-16 23:51:03.000000000 +1000
+++ deprecated.texi	2003-05-23 15:24:08.000000000 +1000
@@ -1,3 +1,24 @@
 @page
 @node Deprecated
 @chapter Deprecated
+
+The features and functions described in this chapter are considered
+obsolete and should not be used by new programs.  They're retained for
+compatibility with past versions of Guile.
+
+@deffn {Scheme Procedure} substring-move-left! str1 start1 end1 str2 start2
+@deffnx {Scheme Procedure} substring-move-right! str1 start1 end1 str2 start2
+These functions are aliases for @code{substring-move!} and calls to
+them can simply be replaced by @code{substring-move!} (@pxref{String
+Modification}.)
+
+In the past, if @var{str1} and @var{str2} were the same string, it was
+necessary to call @code{substring-move-left!} if the move was to the
+left (@math{@var{start2} < @var{start1}}), or call
+@code{substring-move-right!} if the move was to the right
+(@math{@var{start2} > @var{start1}}).  @code{substring-move!} is able
+to do both.
+@end deffn
+
+
+

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

^ permalink raw reply	[flat|nested] 2+ messages in thread