minor documentation tweaks

diff --git a/lib/Imager/Files.pod b/lib/Imager/Files.pod
index 2f1644f3153057b92b92f25d2f0b44d0250d604a..fb95bf22310a658e3c1653125322da9e9a406da3 100644 (file)
--- a/lib/Imager/Files.pod
+++ b/lib/Imager/Files.pod
@@ -46,6 +46,12 @@ method to read an image:
   $img->read(file=>$filename, type=>$type)
     or die "Cannot read $filename: ", $img->errstr;
 
+In most cases Imager can auto-detect the file type, so you can just
+supply the filename:
+
+  $img->read(file => $filename)
+    or die "Cannot read $filename: ", $img->errstr;
+
 =item write
 
 and the C<write()> method to write an image:
@@ -61,6 +67,9 @@ file, use the C<read_multi()> method:
   my @imgs = Imager->read_multi(file=>$filename, type=>$type)
     or die "Cannot read $filename: ", Imager->errstr;
 
+As with the read() method, Imager will normally detect the C<type>
+automatically.
+
 =item write_multi
 
 and if you want to write multiple images to a single file use the
@@ -71,10 +80,10 @@ C<write_multi()> method:
 
 =back
 
-If the I<filename> includes an extension that Imager recognizes, then
-you don't need the I<type>, but you may want to provide one anyway.
-See L</Guessing types> for information on controlling this
-recognition.
+When writing, if the I<filename> includes an extension that Imager
+recognizes, then you don't need the I<type>, but you may want to
+provide one anyway.  See L</Guessing types> for information on
+controlling this recognition.
 
 The C<type> parameter is a lowercase representation of the file type,
 and can be any of the following:
@@ -102,11 +111,11 @@ targets:
 
 =over
 
-=item file
+=item *
 
-The C<file> parameter is the name of the image file to be written to
-or read from.  If Imager recognizes the extension of the file you do
-not need to supply a C<type>.
+file - The C<file> parameter is the name of the image file to be
+written to or read from.  If Imager recognizes the extension of the
+file you do not need to supply a C<type>.
 
   # write in tiff format
   $image->write(file => "example.tif")
@@ -119,9 +128,9 @@ not need to supply a C<type>.
   $image->read(file => 'example.tif')
     or die $image->errstr;
 
-=item fh
+=item 
 
-C<fh> is a file handle, typically either returned from
+fh - C<fh> is a file handle, typically either returned from
 C<<IO::File->new()>>, or a glob from an C<open> call.  You should call
 C<binmode> on the handle before passing it to Imager.
 
@@ -136,9 +145,9 @@ fileno()) rather than writing at the perl level.
   $image->read(fd => $cgi->param('file')) 
     or die $image->errstr;
 
-=item fd
+=item 
 
-C<fd> is a file descriptor.  You can get this by calling the
+fd - C<fd> is a file descriptor.  You can get this by calling the
 C<fileno()> function on a file handle, or by using one of the standard
 file descriptor numbers.
 
@@ -149,12 +158,13 @@ the image.
   $image->write(fd => file(STDOUT), type => 'gif')
     or die $image->errstr;
 
-=item data
+=item 
 
-When reading data, C<data> is a scalar containing the image file data,
-when writing, C<data> is a reference to the scalar to save the image
-file data too.  For GIF images you will need giflib 4 or higher, and
-you may need to patch giflib to use this option for writing.
+data - When reading data, C<data> is a scalar containing the image
+file data, when writing, C<data> is a reference to the scalar to save
+the image file data too.  For GIF images you will need giflib 4 or
+higher, and you may need to patch giflib to use this option for
+writing.
 
   my $data;
   $image->write(data => \$data, type => 'tiff')

diff --git a/lib/Imager/Filters.pod b/lib/Imager/Filters.pod
index 65dc75d3e1e606c7dcac181bedc6227fa3e9cd0d..a590bfe9cd367912b899c024003c2ab57bf441a1 100644 (file)
--- a/lib/Imager/Filters.pod
+++ b/lib/Imager/Filters.pod
@@ -136,7 +136,7 @@ cover the whole possible range for the channel.  I<lsat> and I<usat>
 truncate the range by the specified fraction at the top and bottom of
 the range respectivly.
 
-  # increase contrast, losing little detail
+  # increase contrast per channel, losing little detail
   $img->filter(type=>"autolevels")
     or die $img->errstr;