[Python-checkins] cpython: #444582: fix example and rewrap docs a bit.

[georg.brandl]

http://hg.python.org/cpython/rev/84b48551cd13
changeset:   77725:84b48551cd13
user:        Georg Brandl <georg at python.org>
date:        Sun Jun 24 17:37:07 2012 +0200
summary:
  #444582: fix example and rewrap docs a bit.

files:
  Doc/library/shutil.rst |  27 ++++++++++++++-------------
  1 files changed, 14 insertions(+), 13 deletions(-)


diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -268,31 +268,32 @@
 
    .. versionadded:: 3.3
 
+
 .. function:: which(cmd, mode=os.F_OK | os.X_OK, path=None)
 
-   Return the path to an executable which would be run if the given *cmd*
-   was called. If no *cmd* would be called, return ``None``.
+   Return the path to an executable which would be run if the given *cmd* was
+   called.  If no *cmd* would be called, return ``None``.
 
    *mode* is a permission mask passed a to :func:`os.access`, by default
    determining if the file exists and executable.
 
-   When no *path* is specified, the results of :func:`os.environ` are
-   used, returning either the "PATH" value or a fallback of :attr:`os.defpath`.
+   When no *path* is specified, the results of :func:`os.environ` are used,
+   returning either the "PATH" value or a fallback of :attr:`os.defpath`.
 
-   On Windows, the current directory is always prepended to the *path*
-   whether or not you use the default or provide your own, which
-   is the behavior the command shell uses when finding executables.
-   Additionaly, when finding the *cmd* in the *path*, the
-   ``PATHEXT`` environment variable is checked. For example, if you
-   call ``shutil.which("python")``, :func:`which` will search
-   ``PATHEXT`` to know that it should look for ``python.exe`` within
-   the *path* directories.
+   On Windows, the current directory is always prepended to the *path* whether
+   or not you use the default or provide your own, which is the behavior the
+   command shell uses when finding executables.  Additionaly, when finding the
+   *cmd* in the *path*, the ``PATHEXT`` environment variable is checked.  For
+   example, if you call ``shutil.which("python")``, :func:`which` will search
+   ``PATHEXT`` to know that it should look for ``python.exe`` within the *path*
+   directories.  For example, on Windows::
 
-      >>> print(shutil.which("python"))
+      >>> shutil.which("python")
       'c:\\python33\\python.exe'
 
    .. versionadded:: 3.3
 
+
 .. exception:: Error
 
    This exception collects exceptions that are raised during a multi-file

-- 
Repository URL: http://hg.python.org/cpython