More review changes.

* Favicon.ico is served.
* Test suit now passes.
* Help links work for for me.
* Other changes made to address inline comments.
* The printing of long lines is an extremely subtle issue and I will open an issue for it.
* zmqws.py is completely gone so the naked print is not an issue.
* ipython-notebook removed from scripts.
* Updated copyright and authors of files.
* Fixed missing docstrings in IPython.nbformat.

IPython/__init__.py

@@ -43,14 +43,6 b' sys.path.append(os.path.join(os.path.dirname(__file__), "extensions"))'
 from .config.loader import Config
 from .core import release
 from .core.application import Application
-# Todo: Should these be imported here? We need to rethink what is imported in
-# this module.
-#from .core.display import (
-#    display, display_pretty, display_html, display_latex,
-#    display_png, display_jpeg, display_svg, display_json,
-#    display_javascript, HTML, SVG, Math, Image, JSON,
-#    Javascript, Pretty
-#)
 from .frontend.terminal.embed import embed
 from .core.error import TryNext
 from .core.interactiveshell import InteractiveShell

IPython/core/magic.py

@@ -48,8 +48,7 b' from IPython.core.error import UsageError'
 from IPython.core.fakemodule import FakeModule
 from IPython.core.profiledir import ProfileDir
 from IPython.core.macro import Macro
-from IPython.core import magic_arguments
-from IPython.core import page
+from IPython.core import magic_arguments, page
 from IPython.core.prefilter import ESC_MAGIC
 from IPython.lib.pylabtools import mpl_runner
 from IPython.testing.skipdoctest import skip_doctest

IPython/core/profileapp.py

@@ -195,11 +195,12 b' class ProfileCreate(BaseIPythonApplication):'
             apps.append(IPythonQtConsoleApp)
         try:
             from IPython.frontend.html.notebook.notebookapp import IPythonNotebookApp
-        except Exception:
-            # this should be ImportError, but under weird circumstances
-            # this might be an AttributeError, or possibly others
-            # in any case, nothing should cause the profile creation to crash.
+        except ImportError:
             pass
+        except Exception:
+            self.log.debug('Unexpected error when importing IPythonNotebookApp',
+                           exc_info=True
+            )
         else:
             apps.append(IPythonNotebookApp)
         if self.parallel:

IPython/frontend/html/notebook/handlers.py

@@ -1,9 +1,20 b''
-"""Tornado handlers for the notebook."""
+"""Tornado handlers for the notebook.
+
+Authors:
+
+* Brian Granger
+"""
 
 #-----------------------------------------------------------------------------
-# Imports
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from tornado import web
 from tornado import websocket

IPython/frontend/html/notebook/kernelmanager.py

@@ -1,10 +1,15 b''
-"""A kernel manager for multiple kernels."""
+"""A kernel manager for multiple kernels.
+
+Authors:
+
+* Brian Granger
+"""
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2011  The IPython Development Team
+#  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING.txt, distributed as part of this software.
+#  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------

IPython/frontend/html/notebook/notebookapp.py

@@ -1,10 +1,15 b''
-"""A tornado based IPython notebook server."""
+"""A tornado based IPython notebook server.
+
+Authors:
+
+* Brian Granger
+"""
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2011  The IPython Development Team
+#  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING.txt, distributed as part of this software.
+#  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
@@ -194,9 +199,9 b' class IPythonNotebookApp(BaseIPythonApplication):'
             argv = sys.argv[1:]
 
         self.kernel_argv = list(argv) # copy
-        # kernel should inherit default config file from frontend
+        # Kernel should inherit default config file from frontend
         self.kernel_argv.append("--KernelApp.parent_appname='%s'"%self.name)
-        # scrub frontend-specific flags
+        # Scrub frontend-specific flags
         for a in argv:
             if a.startswith('-') and a.lstrip('-') in notebook_flags:
                 self.kernel_argv.remove(a)
@@ -205,7 +210,6 b' class IPythonNotebookApp(BaseIPythonApplication):'
                 alias = a.lstrip('-').split('=')[0]
                 if alias in notebook_aliases:
                     self.kernel_argv.remove(a)
-        print self.kernel_argv
 
     def init_configurables(self):
         # Don't let Qt or ZMQ swallow KeyboardInterupts.
@@ -241,18 +245,20 b' class IPythonNotebookApp(BaseIPythonApplication):'
             self.log.critical('WARNING: the notebook server is listening on all IP addresses '
                               'but not using any encryption or authentication. This is highly '
                               'insecure and not recommended.')
-        for i in range(10):
+
+        # Try random ports centered around the default.
+        from random import randint
+        n = 50  # Max number of attempts, keep reasonably large.
+        for port in [self.port] + [self.port + randint(-2*n, 2*n) for i in range(n)]:
             try:
-                port = self.port + i
                 self.http_server.listen(port, self.ip)
             except socket.error, e:
                 if e.errno != errno.EADDRINUSE:
                     raise
-                self.log.info('The port %i is already in use, trying: %i' % (port, port+1))
+                self.log.info('The port %i is already in use, trying another random port.' % port)
             else:
                 self.port = port
                 break
-    
 
     def start(self):
         ip = self.ip if self.ip else '[all ip addresses on your system]'

IPython/frontend/html/notebook/notebookmanager.py

@@ -1,8 +1,15 b''
+"""A notebook manager that uses the local file system for storage.
+
+Authors:
+
+* Brian Granger
+"""
+
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2011  The IPython Development Team
+#  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING.txt, distributed as part of this software.
+#  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
@@ -46,7 +53,7 b' class NotebookManager(LoggingConfigurable):'
             dict(notebook_id=notebook,name=name)
         """
         names = os.listdir(self.notebook_dir)
-        names = [name.split(u'.')[0] \
+        names = [name.split(u'.')[0]
             for name in names if name.endswith(self.filename_ext)]
         data = []
         for name in names:
@@ -76,9 +83,7 b' class NotebookManager(LoggingConfigurable):'
         if notebook_id not in self.mapping:
             return False
         path = self.get_path_by_name(self.mapping[notebook_id])
-        if not os.path.isfile(path):
-            return False
-        return True        
+        return os.path.isfile(path)
 
     def find_path(self, notebook_id):
         """Return a full path to a notebook given its notebook_id."""

IPython/frontend/html/notebook/static/js/cell.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Cell

IPython/frontend/html/notebook/static/js/codecell.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // CodeCell

IPython/frontend/html/notebook/static/js/kernel.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Kernel

IPython/frontend/html/notebook/static/js/kernelstatus.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Kernel Status widget

IPython/frontend/html/notebook/static/js/layout.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Layout

IPython/frontend/html/notebook/static/js/leftpanel.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // LeftPanel

IPython/frontend/html/notebook/static/js/namespace.js

@@ -1,3 +1,10 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
+
 var IPython = IPython || {};
 
 IPython.namespace = function (ns_string) {

IPython/frontend/html/notebook/static/js/nbbrowser_main.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // On document ready

IPython/frontend/html/notebook/static/js/notebook.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Notebook

IPython/frontend/html/notebook/static/js/notebook_main.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // On document ready

IPython/frontend/html/notebook/static/js/notebooklist.js

@@ -1,6 +1,12 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
-// Cell
+// NotebookList
 //============================================================================
 
 var IPython = (function (IPython) {

IPython/frontend/html/notebook/static/js/pager.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Pager

IPython/frontend/html/notebook/static/js/panelsection.js

@@ -1,6 +1,12 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
-// Cell
+// PanelSection
 //============================================================================
 
 var IPython = (function (IPython) {

IPython/frontend/html/notebook/static/js/savewidget.js

@@ -1,6 +1,12 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
-// Cell
+// SaveWidget
 //============================================================================
 
 var IPython = (function (IPython) {

IPython/frontend/html/notebook/static/js/textcell.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // TextCell

IPython/frontend/html/notebook/static/js/utils.js

@@ -1,3 +1,9 b''
+//----------------------------------------------------------------------------
+//  Copyright (C) 2008-2011  The IPython Development Team
+//
+//  Distributed under the terms of the BSD License.  The full license is in
+//  the file COPYING, distributed as part of this software.
+//----------------------------------------------------------------------------
 
 //============================================================================
 // Utilities

IPython/frontend/html/notebook/tests/test_kernelsession.py

@@ -3,7 +3,6 b''
 from unittest import TestCase
 
 from IPython.frontend.html.notebook.kernelmanager import KernelManager
-from IPython.frontend.html.notebook.sessionmanager import SessionManagerRunningError
 
 class TestKernelManager(TestCase):
 
@@ -24,16 +23,4 b' class TestKernelManager(TestCase):'
         self.assert_('hb_port' in port_dict)
         km.get_kernel_process(kid)
 
-    def test_session_manager(self):
-        km = KernelManager()
-        kid = km.start_kernel()
-        sm = km.create_session_manager(kid)
-        self.assert_(sm._running)
-        sm.stop()
-        self.assert_(not sm._running)
-        sm.start()
-        self.assertRaises(SessionManagerRunningError, sm.start)
-        sm.get_iopub_stream()
-        sm.get_shell_stream()
-        sm.session
 

IPython/frontend/html/notebook/zmqhttp.py

@@ -1,9 +1,29 b''
-import json
+"""Unfinished code for ZMQ/HTTP bridging. We use WebSockets instead.
 
-from tornado import web
+Authors:
+
+* Brian Granger
+"""
 
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+import json
 import logging
 
+from tornado import web
+
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class ZMQHandler(web.RequestHandler):
 
@@ -74,7 +94,3 b' class ZMQXReqHandler(ZMQHandler):'
             stream.send_json(msg)
             stream.on_recv(self._handle_msgs)
 
-
-
-
-    
  No newline at end of file

IPython/nbformat/current.py

@@ -1,3 +1,21 b''
+"""The official API for working with notebooks in the current format version.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
 import json
 from xml.etree import ElementTree as ET
 import re
@@ -11,6 +29,9 b' from IPython.nbformat.v2 import ('
     parse_filename
 )
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 current_nbformat = 2
 

IPython/nbformat/v1/__init__.py

@@ -1,3 +1,15 b''
+"""The main module for the v1 notebook format."""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from .nbbase import (
     NotebookNode,

IPython/nbformat/v1/convert.py

@@ -1,4 +1,15 b''
+"""Convert notebook to the v1 format."""
 
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 def convert_to_this_nbformat(nb, orig_version=None):
     raise ValueError('Cannot convert to v1 notebook format')

IPython/nbformat/v1/nbbase.py

@@ -1,10 +1,29 b''
-"""The basic dict based notebook format."""
+"""The basic dict based notebook format.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 import pprint
 import uuid
 
 from IPython.utils.ipstruct import Struct
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class NotebookNode(Struct):
     pass

IPython/nbformat/v1/nbjson.py

@@ -1,10 +1,29 b''
-"""Read and write notebooks in JSON format."""
+"""Read and write notebooks in JSON format.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from base64 import encodestring
 from .rwbase import NotebookReader, NotebookWriter
 from .nbbase import from_dict
 import json
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class JSONReader(NotebookReader):
 

IPython/nbformat/v1/rwbase.py

@@ -1,5 +1,26 b''
+"""Base classes and function for readers and writers.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
 from base64 import encodestring, decodestring
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class NotebookReader(object):
 

IPython/nbformat/v2/__init__.py

@@ -1,3 +1,20 b''
+"""The main API for the v2 notebook format.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from .nbbase import (
     NotebookNode,
@@ -18,6 +35,9 b' from .nbpy import to_notebook as to_notebook_py'
 
 from .convert import convert_to_this_nbformat
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 def parse_filename(fname):
     """Parse a notebook filename.

IPython/nbformat/v2/convert.py

@@ -1,8 +1,39 b''
+"""Code for converting notebooks to and from the v2 format.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
 from .nbbase import (
     new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
 )
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
+
 def convert_to_this_nbformat(nb, orig_version=1):
+    """Convert a notebook to the v2 format.
+
+    Parameters
+    ----------
+    nb : NotebookNode
+        The Python representation of the notebook to convert.
+    orig_version : int
+        The original version of the notebook to convert.
+    """
     if orig_version == 1:
         newnb = new_notebook()
         ws = new_worksheet()
@@ -17,4 +48,3 b' def convert_to_this_nbformat(nb, orig_version=1):'
     else:
         raise ValueError('Cannot convert a notebook from v%s to v2' % orig_version)
 
-

IPython/nbformat/v2/nbbase.py

@@ -1,10 +1,34 b''
-"""The basic dict based notebook format."""
+"""The basic dict based notebook format.
+
+The Python representation of a notebook is a nested structure of 
+dictionary subclasses that support attribute access
+(IPython.utils.ipstruct.Struct). The functions in this module are merely
+helpers to build the structs in the right form.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 import pprint
 import uuid
 
 from IPython.utils.ipstruct import Struct
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class NotebookNode(Struct):
     pass

IPython/nbformat/v2/nbjson.py

@@ -1,10 +1,29 b''
-"""Read and write notebooks in JSON format."""
+"""Read and write notebooks in JSON format.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from base64 import encodestring
 from .nbbase import from_dict
 from .rwbase import NotebookReader, NotebookWriter, base64_decode
 import json
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class BytesEncoder(json.JSONEncoder):
     def default(self, obj):

IPython/nbformat/v2/nbpy.py

@@ -1,8 +1,27 b''
-"""Read and write notebooks as regular .py files."""
+"""Read and write notebooks as regular .py files.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from .rwbase import NotebookReader, NotebookWriter
 from .nbbase import new_code_cell, new_text_cell, new_worksheet, new_notebook
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
 
 class PyReaderError(Exception):
     pass

IPython/nbformat/v2/nbxml.py

@@ -1,4 +1,20 b''
-"""Read and write notebook files as XML."""
+"""Read and write notebook files as XML.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
 
 from base64 import encodestring, decodestring
 from xml.etree import ElementTree as ET
@@ -8,6 +24,10 b' from .nbbase import ('
     new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
 )
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
+
 def indent(elem, level=0):
     i = "\n" + level*"  "
     if len(elem):

IPython/nbformat/v2/rwbase.py

@@ -1,6 +1,28 b''
+"""Base classes and utilities for readers and writers.
+
+Authors:
+
+* Brian Granger
+"""
+
+#-----------------------------------------------------------------------------
+#  Copyright (C) 2008-2011  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
 from base64 import encodestring, decodestring
 import pprint
 
+#-----------------------------------------------------------------------------
+# Code
+#-----------------------------------------------------------------------------
+
 def base64_decode(nb):
     """Base64 encode all bytes objects in the notebook."""
     for ws in nb.worksheets:
@@ -26,6 +48,7 b' def base64_encode(nb):'
 
 
 class NotebookReader(object):
+    """A class for reading notebooks."""
 
     def reads(self, s, **kwargs):
         """Read a notebook from a string."""
@@ -37,6 +60,7 b' class NotebookReader(object):'
 
 
 class NotebookWriter(object):
+    """A class for writing notebooks."""
 
     def writes(self, nb, **kwargs):
         """Write a notebook to a string."""