# HG changeset patch
# User Tero Marttila <terom@fixme.fi>
# Date 1245251329 -10800
# Node ID 0c1c092bbc5d268209964ab367c52a08cc86ce86
# Parent  c2b2f4b6fe6d7547e8333f71e236e6d1e08e53d3
slight doc tweaks for Folder

diff -r c2b2f4b6fe6d -r 0c1c092bbc5d degal/folder.py
--- a/degal/folder.py	Wed Jun 17 17:56:02 2009 +0300
+++ b/degal/folder.py	Wed Jun 17 18:08:49 2009 +0300
@@ -10,7 +10,12 @@
 
 class Folder (filesystem.Directory) :
     """
-        A Folder is a filesystem Directory that contains any number of other Folders and Images.
+        A Folder is a filesystem Directory that:
+            * has a title/description (XXX: Page)
+            * contains any number of other sub-Folders and Images.
+            * can load custom configuration for itself and sub-nodes to override the base config
+            * holds sub-dirs for previews/thumbs
+            * has a HTML view
     """
 
     def iter_config_files (self) :
@@ -32,8 +37,9 @@
 
                 break
 
-        # load some info from title?
+        # load some info for title?
         if self.config and self.config.title :
+            # override our default title
             self.title = self.config.title
 
             # disable it so it won't be used by children
@@ -43,7 +49,7 @@
     @lazy_load
     def title (self) :
         """
-            Find the title for this dir
+            Find the default title for this dir.
         """
 
         # default
@@ -61,7 +67,7 @@
     @lazy_load
     def preview_dir (self) :
         """
-            Load and return the Directory for previews
+            Load and return the Directory used for for preview Thumbnails
         """
         
         return self.subdir(self.config.preview_dir, create=True)
@@ -69,7 +75,7 @@
     @lazy_load
     def thumb_dir (self) :
         """
-            Load and return the Directory for thumbs
+            Load and return the Directory used for thumb Thumbnails
         """
         
         return self.subdir(self.config.thumb_dir, create=True)