# HG changeset patch
# User k0s <k0scist@gmail.com>
# Date 1267899751 18000
# Node ID 6ec33e2ce60fc6eeaf3099d12598aaaad1dd5dea
# Parent  2be0070c6f9566783ebd64c1ccf96db7c95cbc37
more documentation

diff -r 2be0070c6f95 -r 6ec33e2ce60f README.txt
--- a/README.txt	Sat Mar 06 13:11:46 2010 -0500
+++ b/README.txt	Sat Mar 06 13:22:31 2010 -0500
@@ -8,9 +8,24 @@
 API
 ---
 
+cropresize contains one useful function, ``cropresize.crop_resize``.
+The function takes three arguments:
+
+    * image: a PIL image object
+    * size: a 2-tuple of (width,height);  at least one must be specified
+    * exact_size: whether to scale up for smaller images  
+
+See ``cropresize.crop_resize.__doc__`` for the function
+documentation.  ``crop_resize`` returns the cropped and resized PIL image.
+
+
 Command Line
 ------------
 
 The command line program, ``crop-resize``, is included in this python
 package.  The help for the program is displayed by running
 ``crop-resize`` with no arguments or ``crop-resize --help``.
+
+--
+
+http://k0s.org/portfolio/software.html#cropresize
diff -r 2be0070c6f95 -r 6ec33e2ce60f cropresize/__init__.py
--- a/cropresize/__init__.py	Sat Mar 06 13:11:46 2010 -0500
+++ b/cropresize/__init__.py	Sat Mar 06 13:22:31 2010 -0500
@@ -6,10 +6,14 @@
 def crop_resize(image, size, exact_size=False):
     """
     Crop out the proportional middle of the image and set to the desired size.
+    * image: a PIL image object
+    * size: a 2-tuple of (width,height);  at least one must be specified
+    * exact_size: whether to scale up for smaller images
     If the image is bigger than the sizes passed, this works as expected.
     If the image is smaller than the sizes passed, then behavior is dictated
-    by the `exact_size` flag.  If the 
-
+    by the ``exact_size`` flag.  If the ``exact_size`` flag is false,
+    the image will be returned unmodified.  If the ``exact_size`` flag is true,
+    the image will be scaled up to the required size.
     """
     assert size[0] or size[1]
 
@@ -47,7 +51,7 @@
 
 def main():
     from optparse import OptionParser
-    parser = OptionParser()
+    parser = OptionParser('%prog [options] image1.png [image2.jpg] [...]')
     parser.add_option('-W', '--width')
     parser.add_option('-H', '--height')
     parser.add_option('-e', '--exact-size', dest='exact', action='store_true', default=False)