diff decoupage/formatters.py @ 27:9e86c5cb111a

minor documentation updates
author k0s <k0scist@gmail.com>
date Mon, 18 Jan 2010 15:33:42 -0500
parents 6b27461955d1
children fc1c479296c3
line wrap: on
line diff
--- a/decoupage/formatters.py	Sun Jan 17 19:49:04 2010 -0500
+++ b/decoupage/formatters.py	Mon Jan 18 15:33:42 2010 -0500
@@ -36,7 +36,10 @@
 ### formatters
 
 class Ignore(object):
-    """ignore files of a certain pattern"""
+    """
+    ignore files of a glob patterns.  These files will not be used in the index template.
+    e.g. /ignore = .* *.pdf  # don't list dotfiles and PDFs
+    """
     
 
     def __init__(self, ignore):
@@ -79,7 +82,11 @@
         data['files'] = _files
         
 class Sort(object):
-    """ determines how to sort the files in a directory """
+    """
+    determines how to sort the files in a directory; 
+    right now only by case-insensitive alphabetically
+    * reverse : reverse the 
+    """
     def __init__(self, pattern):
         self.args = [i.strip() for i in pattern.split(',')]