]> granicus.if.org Git - python/commitdiff
#444582: fix example and rewrap docs a bit.
authorGeorg Brandl <georg@python.org>
Sun, 24 Jun 2012 15:37:07 +0000 (17:37 +0200)
committerGeorg Brandl <georg@python.org>
Sun, 24 Jun 2012 15:37:07 +0000 (17:37 +0200)
Doc/library/shutil.rst

index 7526e5e19031202e958acbbd3c73ecb7f226f61c..aeaf62cb3087e588fbea7a9dda5507fb3047e5e9 100644 (file)
@@ -268,31 +268,32 @@ Directory and files operations
 
    .. 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