fix some docstrings and comments draft
authoralain leufroy <alain@leufroy.fr>
Tue, 02 Apr 2013 18:27:47 +0200
changeset 27 a5127c7db5d9
parent 16 a3f3c61347c1
child 28 2a2d268844f1
fix some docstrings and comments
h5fs.py
--- a/h5fs.py	Thu Mar 28 23:43:43 2013 +0100
+++ b/h5fs.py	Tue Apr 02 18:27:47 2013 +0200
@@ -86,16 +86,19 @@
     @staticmethod
     def get_name(h5entry):
         '''Return the entry file name as string'''
-        # XXX unicode seems not to be allowed
+        # XXX unicode does not seem to be allowed
         return str(osp.basename(h5entry.name))
 
     @staticmethod
     def get_data(h5entry, start, end):
+        '''Return a slice of data from start to end'''
         return h5entry.value.data[start:end]
 
     def list_group(self, group, specs=('.', '..')):
         '''A fonction generator that yields name of the entries in the group.
-        The list is in arbritary order with specials entries ``specs``.'''
+        The list is in arbitrary order with special entries ``specs``.
+        This names are used as file/folder names
+        '''
         return chain(iter(specs), imap(self.get_name, group.itervalues()))
 
     @staticmethod
@@ -107,7 +110,8 @@
 # ===
 
     def readdir(self, path, offset):
-        '''Return a generator that yields entries from the given Group path'''
+        '''Return a generator that yields entries from the given Group path
+        used as file/folder contained in path'''
         convert = partial(fuse.Direntry, offset=offset)
         return imap(convert, self.list_group(self.get_entry(path)))