added documentation to more functions and methods

ivanov · ivanov · commit 39aa8a9f3643 · 2012-10-26T18:38:29.000-07:00
diff --git a/nbconvert.py b/nbconvert.py
@@ -195,6 +195,9 @@ def markdown2rst(src):
 
 
 def rst_directive(directive, text=''):
+    """
+    Makes ReST directive block and indents any text passed to it.
+    """
     out = [directive, '']
     if text:
         out.extend([indent(text), ''])
@@ -270,6 +273,22 @@ def dispatch_display_format(self, format):
         return getattr(self, 'render_display_format_' + format, self.render_unknown_display)
 
     def convert(self, cell_separator='\n'):
+        """
+        Generic method to converts notebook to a string representation.
+
+        This is accomplished by dispatching on the cell_type, so subclasses of
+        Convereter class do not need to re-implement this method, but just
+        need implementation for the methods that will be dispatched.
+
+        Parameters
+        ----------
+        cell_separator : string
+          Character or string to join cells with. Default is "\n"
+
+        Returns
+        -------
+        out : string
+        """
         lines = []
         lines.extend(self.optional_header())
         converted_cells = []
@@ -308,9 +327,19 @@ def save(self, outfile=None, encoding=None):
         return os.path.abspath(outfile)
 
     def optional_header(self):
+        """
+        Optional header to insert at the top of the converted notebook
+
+        Returns a list
+        """
         return []
 
     def optional_footer(self):
+        """
+        Optional footer to insert at the end of the converted notebook
+
+        Returns a list
+        """
         return []
 
     def _new_figure(self, data, fmt):
