note how os.utime should be used for emulating touch

5b02ef3e · Benjamin Peterson · 4eb99393 · 5b02ef3e
Commit 5b02ef3e authored Aug 16, 2008 by Benjamin Peterson
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 9 deletions

Doc/library/os.rst Doc/library/os.rst +10 -9

No files found.
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1303,15 +1303,16 @@ Files and Directories
 .. function:: utime(path, times)
-   Set the access and modified times of the file specified by *path*. If *times* is
+   Set the access and modified times of the file specified by *path*. If *times*
-   ``None``, then the file's access and modified times are set to the current time.
+   is ``None``, then the file's access and modified times are set to the current
-   Otherwise, *times* must be a 2-tuple of numbers, of the form ``(atime, mtime)``
+   time. (The effect is similar to running the Unix program :program:`touch` on
-   which is used to set the access and modified times, respectively. Whether a
+   the path.)  Otherwise, *times* must be a 2-tuple of numbers, of the form
-   directory can be given for *path* depends on whether the operating system
+   ``(atime, mtime)`` which is used to set the access and modified times,
-   implements directories as files (for example, Windows does not).  Note that the
+   respectively. Whether a directory can be given for *path* depends on whether
-   exact times you set here may not be returned by a subsequent :func:`stat` call,
+   the operating system implements directories as files (for example, Windows
-   depending on the resolution with which your operating system records access and
+   does not).  Note that the exact times you set here may not be returned by a
-   modification times; see :func:`stat`.
+   subsequent :func:`stat` call, depending on the resolution with which your
+   operating system records access and modification times; see :func:`stat`.
   .. versionchanged:: 2.0
      Added support for ``None`` for *times*.