make it even clearer that scale() and variants don't modify the source

diff --git a/TODO b/TODO
index fa60c48221d34ae0ec5cad1a5ecdb5962e777aaa..fac5e1c905fd080ebf7d4a40146657720f7dad33 100644 (file)
--- a/TODO
+++ b/TODO
@@ -12,7 +12,7 @@ RGB file support (#8666) (done)
 
 convert() doesn't preserve sample size (#28492) (done)
 
 
 convert() doesn't preserve sample size (#28492) (done)
 

-be explicit that scale*() doesn't modify the source (#28570)
+be explicit that scale*() doesn't modify the source (#28570) (done)

 
 new color counting code (#28142)
 
 
 new color counting code (#28142)
 

diff --git a/lib/Imager/Transformations.pod b/lib/Imager/Transformations.pod
index 78412a99bb94bbdcca9cdfbd83197445e7de0176..43bbb33de632ccb8fcb5016459c5906cce22cbb5 100644 (file)
--- a/lib/Imager/Transformations.pod
+++ b/lib/Imager/Transformations.pod
@@ -99,7 +99,7 @@ wide and 500 pixels tall.
   $newimg = $img->scale(scalefactor=>0.25); 175x125 
   $newimg = $img->scale(); # 350x250
 
   $newimg = $img->scale(scalefactor=>0.25); 175x125 
   $newimg = $img->scale(); # 350x250
 

-if you want to create low quality previews of images you can pass
+If you want to create low quality previews of images you can pass

 C<qtype=E<gt>'preview'> to scale and it will use nearest neighbor
 sampling instead of filtering. It is much faster but also generates
 worse looking images - especially if the original has a lot of sharp
 C<qtype=E<gt>'preview'> to scale and it will use nearest neighbor
 sampling instead of filtering. It is much faster but also generates
 worse looking images - especially if the original has a lot of sharp


@@ -210,7 +210,8 @@ or by supplying C<xpixels> and C<ypixels> and setting C<type> to
 
   my $scaled = $im->scale(xpixels => 200, ypixels => 200, type => 'nonprop');
 
 
   my $scaled = $im->scale(xpixels => 200, ypixels => 200, type => 'nonprop');
 

-Returns the scaled image on success.
+Returns a new scaled image on success.  The source image is not
+modified.

 
 Returns false on failure, check the errstr() method for the reason for
 failure.
 
 Returns false on failure, check the errstr() method for the reason for
 failure.


@@ -278,7 +279,8 @@ pixels - the new width of the image.
 
 =back
 
 
 =back
 

-Returns the scaled image on success.
+Returns a new scaled image on success.  The source image is not
+modified.

 
 Returns false on failure, check the errstr() method for the reason for
 failure.
 
 Returns false on failure, check the errstr() method for the reason for
 failure.


@@ -306,7 +308,8 @@ pixels - the new height of the image.
 
 =back
 
 
 =back
 

-Returns the scaled image on success.
+Returns a new scaled image on success.  The source image is not
+modified.

 
 Returns false on failure, check the errstr() method for the reason for
 failure.
 
 Returns false on failure, check the errstr() method for the reason for
 failure.