DOC: Fix docstring warnings in documetation generation.

Most of these fixes involve putting blank lines around

.. versionadded:: x.x.x

and

.. deprecated:: x.x.x

Some of the examples were also fixed.

1 files changed, 50 insertions, 32 deletions

diff --git a/numpy/distutils/exec_command.py b/numpy/distutils/exec_command.py
index f4b6f5928..f0382accc 100644
--- a/numpy/distutils/exec_command.py
+++ b/numpy/distutils/exec_command.py
@@ -9,6 +9,7 @@ values may be different by a factor). In addition, exec_command
 takes keyword arguments for (re-)defining environment variables.
 
 Provides functions:
+
   exec_command  --- execute command in a specified directory and
                     in the modified environment.
   find_executable --- locate a command using info from environment
@@ -21,28 +22,33 @@ Created: 11 January 2003
 Requires: Python 2.x
 
 Succesfully tested on:
-  os.name | sys.platform | comments
-  --------+--------------+----------
-  posix   | linux2       | Debian (sid) Linux, Python 2.1.3+, 2.2.3+, 2.3.3
-                           PyCrust 0.9.3, Idle 1.0.2
-  posix   | linux2       | Red Hat 9 Linux, Python 2.1.3, 2.2.2, 2.3.2
-  posix   | sunos5       | SunOS 5.9, Python 2.2, 2.3.2
-  posix   | darwin       | Darwin 7.2.0, Python 2.3
-  nt      | win32        | Windows Me
-                           Python 2.3(EE), Idle 1.0, PyCrust 0.7.2
-                           Python 2.1.1 Idle 0.8
-  nt      | win32        | Windows 98, Python 2.1.1. Idle 0.8
-  nt      | win32        | Cygwin 98-4.10, Python 2.1.1(MSC) - echo tests
-                           fail i.e. redefining environment variables may
-                           not work. FIXED: don't use cygwin echo!
-                           Comment: also `cmd /c echo` will not work
-                           but redefining environment variables do work.
-  posix   | cygwin       | Cygwin 98-4.10, Python 2.3.3(cygming special)
-  nt      | win32        | Windows XP, Python 2.3.3
+
+========  ============  =================================================
+os.name   sys.platform  comments
+========  ============  =================================================
+posix     linux2        Debian (sid) Linux, Python 2.1.3+, 2.2.3+, 2.3.3
+                        PyCrust 0.9.3, Idle 1.0.2
+posix     linux2        Red Hat 9 Linux, Python 2.1.3, 2.2.2, 2.3.2
+posix     sunos5        SunOS 5.9, Python 2.2, 2.3.2
+posix     darwin        Darwin 7.2.0, Python 2.3
+nt        win32         Windows Me
+                        Python 2.3(EE), Idle 1.0, PyCrust 0.7.2
+                        Python 2.1.1 Idle 0.8
+nt        win32         Windows 98, Python 2.1.1. Idle 0.8
+nt        win32         Cygwin 98-4.10, Python 2.1.1(MSC) - echo tests
+                        fail i.e. redefining environment variables may
+                        not work. FIXED: don't use cygwin echo!
+                        Comment: also `cmd /c echo` will not work
+                        but redefining environment variables do work.
+posix     cygwin        Cygwin 98-4.10, Python 2.3.3(cygming special)
+nt        win32         Windows XP, Python 2.3.3
+========  ============  =================================================
 
 Known bugs:
-- Tests, that send messages to stderr, fail when executed from MSYS prompt
+
+* Tests, that send messages to stderr, fail when executed from MSYS prompt
   because the messages are lost at some point.
+
 """
 from __future__ import division, absolute_import, print_function
 
@@ -148,21 +154,33 @@ def _supports_fileno(stream):
     else:
         return False
 
-def exec_command( command,
-                  execute_in='', use_shell=None, use_tee = None,
-                  _with_python = 1,
-                  **env ):
-    """ Return (status,output) of executed command.
-
-    command is a concatenated string of executable and arguments.
-    The output contains both stdout and stderr messages.
-    The following special keyword arguments can be used:
-      use_shell - execute `sh -c command`
-      use_tee   - pipe the output of command through tee
-      execute_in - before run command `cd execute_in` and after `cd -`.
-
+def exec_command(command, execute_in='', use_shell=None, use_tee=None,
+                 _with_python = 1, **env ):
+    """
+    Return (status,output) of executed command.
+
+    Parameters
+    ----------
+    command : str
+        A concatenated string of executable and arguments.
+    execute_in : str
+        Before running command ``cd execute_in`` and after ``cd -``.
+    use_shell : {bool, None}, optional
+        If True, execute ``sh -c command``. Default None (True)
+    use_tee : {bool, None}, optional
+        If True use tee. Default None (True)
+
+
+    Returns
+    -------
+    res : str
+        Both stdout and stderr messages.
+
+    Notes
+    -----
     On NT, DOS systems the returned status is correct for external commands.
     Wild cards will not work for non-posix systems or when use_shell=0.
+
     """
     log.debug('exec_command(%r,%s)' % (command,\
          ','.join(['%s=%r'%kv for kv in env.items()])))