Merging -r 1182 from lp:ipython.

Minor conflicts with removal of testing/attic.

IPython/core/iplib.py

@@ -927,8 +927,8 b' class InteractiveShell(object,Magic):'
         Certain history lists are also initialized here, as they effectively
         act as user namespaces.
 
-        Note
-        ----
+        Notes
+        -----
         All data structures here are only filled in, they are NOT reset by this
         method.  If they were not empty before, data will simply be added to
         therm.
@@ -1315,8 +1315,8 b' class InteractiveShell(object,Magic):'
     def user_setup(self,ipythondir,rc_suffix,mode='install'):
         """Install the user configuration directory.
 
-        Note
-        ----
+        Notes
+        -----
         DEPRECATED: use the top-level user_setup() function instead.
         """
         return user_setup(ipythondir,rc_suffix,mode)

IPython/core/magic.py

@@ -3345,7 +3345,7 b' Defaulting color scheme to \'NoColor\'"""'
 
         See also
         --------
-        %paste: automatically pull code from clipboard.
+        paste: automatically pull code from clipboard.
         """
         
         opts,args = self.parse_options(parameter_s,'rs:',mode='string')
@@ -3384,7 +3384,7 b' Defaulting color scheme to \'NoColor\'"""'
 
         See also
         --------
-        %cpaste: manually paste code into terminal until you mark its end.
+        cpaste: manually paste code into terminal until you mark its end.
         """
         opts,args = self.parse_options(parameter_s,'r:',mode='string')
         par = args.strip()

IPython/frontend/linefrontendbase.py

@@ -97,8 +97,8 b' class LineFrontEndBase(FrontEndBase):'
         ----------
         line : string
         
-        Result
-        ------
+        Returns
+        -------
         The replacement for the line and the list of possible completions.
         """
         completions = self.shell.complete(line)

IPython/frontend/prefilterfrontend.py

@@ -65,8 +65,8 b' class PrefilterFrontEnd(LineFrontEndBase):'
     debug = False
     
     def __init__(self, ipython0=None, argv=None, *args, **kwargs):
-        """ Parameters:
-            -----------
+        """ Parameters
+            ----------
 
             ipython0: an optional ipython0 instance to use for command
             prefiltering and completion.

IPython/kernel/core/interpreter.py

@@ -729,8 +729,8 b' class Interpreter(object):'
     def error(self, text):
         """ Pass an error message back to the shell.
 
-        Preconditions
-        -------------
+        Notes
+        -----
         This should only be called when self.message is set. In other words,
         when code is being executed.
 

IPython/kernel/core/notification.py

@@ -21,8 +21,8 b' __test__ = {}'
 class NotificationCenter(object):
     """Synchronous notification center
     
-    Example
-    -------
+    Examples
+    --------
     >>> import IPython.kernel.core.notification as notification
     >>> def callback(theType, theSender, args={}):
     ...     print theType,theSender,args
@@ -49,8 +49,8 b' class NotificationCenter(object):'
         """Post notification (type,sender,**kwargs) to all registered
         observers. 
         
-        Implementation
-        --------------
+        Implementation notes:
+
         * If no registered observers, performance is O(1).
         * Notificaiton order is undefined.
         * Notifications are posted synchronously.

IPython/kernel/core/util.py

@@ -106,6 +106,9 b' def make_quoted_expr(s):'
 def system_shell(cmd, verbose=False, debug=False, header=''):
     """ Execute a command in the system shell; always return None.
 
+    This returns None so it can be conveniently used in interactive loops
+    without getting the return value (typically 0) printed many times.
+
     Parameters
     ----------
     cmd : str
@@ -117,11 +120,6 b" def system_shell(cmd, verbose=False, debug=False, header=''):"
     header : str
         Header to print to screen prior to the executed command. No extra
         newlines are added.
-
-    Description
-    -----------
-    This returns None so it can be conveniently used in interactive loops
-    without getting the return value (typically 0) printed many times.
     """
 
     if verbose or debug: 

IPython/kernel/multiengineclient.py

@@ -86,14 +86,13 b' class PendingResult(object):'
     
     A user should not create a `PendingResult` instance by hand.
     
-    Methods
-    =======
+    Methods:
     
     * `get_result`
     * `add_callback`
     
-    Properties
-    ==========
+    Properties:
+    
     * `r`
     """
     

IPython/kernel/task.py

@@ -414,7 +414,7 b' class ResultNS(object):'
     This can be a bad idea, as it may corrupt standard behavior of the
     ns object.
     
-    Example
+    Examples
     --------
     
     >>> ns = ResultNS({'a':17,'foo':range(3)})

IPython/testing/plugin/show_refs.py

@@ -10,6 +10,7 b' class C(object):'
       pass
       #print 'deleting object...'  # dbg
 
+if __name__ == '__main__':
 c = C()
 
 c_refs = gc.get_referrers(c)

IPython/utils/genutils.py

@@ -892,8 +892,8 b' def doctest_reload():'
       hard monkeypatch seems like a reasonable solution rather than asking
       users to manually use a different doctest runner when under IPython.
 
-    Note
-    ----
+    Notes
+    -----
 
     This function *used to* reload doctest, but this has been disabled because
     reloading doctest unconditionally can cause massive breakage of other

docs/source/parallel/parallel_mpi.txt

@@ -38,7 +38,7 b' To use code that calls MPI, there are typically two things that MPI requires.'
 There are a couple of ways that you can start the IPython engines and get these things to happen.
 
 Automatic starting using :command:`mpiexec` and :command:`ipcluster`
--------------------------------------------------------------------
+--------------------------------------------------------------------
 
 The easiest approach is to use the `mpiexec` mode of :command:`ipcluster`, which will first start a controller and then a set of engines using :command:`mpiexec`::
 
@@ -48,7 +48,7 b' This approach is best as interrupting :command:`ipcluster` will automatically'
 stop and clean up the controller and engines.
 
 Manual starting using :command:`mpiexec`
----------------------------------------
+----------------------------------------
 
 If you want to start the IPython engines using the :command:`mpiexec`, just do::