Changeset 747:3469bb236ef4 in hatta-dev

Timestamp:

01/24/10 15:36:26 (2 years ago)

Author:

sheep@…

Branch:

default

Message:

docstrings

Files:

• hatta.py (modified) (4 diffs)
• tests/test_repo.py (modified) (2 diffs)

hatta.py

@@ -686 +686 @@
 
     def _title_to_file(self, title):
-        """Modified escaping to allow slashes and spaces."""
+        """Modified escaping allowing (some) slashes and spaces."""
 
         title = unicode(title).strip()
@@ -696 +696 @@
 
     def save_file(self, title, file_name, author=u'', comment=u'', parent=None):
-        """Make the subdirectories if needed."""
+        """
+        Save the file and make the subdirectories if needed.
+        """
 
         file_path = self._file_path(title)
@@ -709 +711 @@
 
     def delete_page(self, title, author=u'', comment=u''):
+        """
+        Remove empty directories after deleting a page.
+
+        Note that Mercurial doesn't track directories, so we don't have to
+        commit after removing empty directories.
+        """
+
         super(WikiSubdirectoryStorage, self).delete_page(title, author, comment)
         file_path = self._file_path(title)
@@ -714 +723 @@
         dir_path = os.path.dirname(file_path)
         os.removedirs(dir_path)
+
 
 class WikiParser(object):

tests/test_repo.py

@@ -80 +80 @@
 
     def test_title_to_file(self, subdir_repo):
+        """
+        Test the modified filename escpaing.
+        """
+
         for title, filename in self.title_encodings.iteritems():
             escaped = subdir_repo._title_to_file(title)
@@ -97 +101 @@
 
     def test_subdirectory_delete(self, subdir_repo):
+        """
+        Check if empty subdirectories are removed on page delete.
+        """
+
         title = u'foo/bar'
         filepath = os.path.join(subdir_repo.path, 'foo/bar')