summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2000-05-01 16:18:22 +0000
committerBarry Warsaw <barry@python.org>2000-05-01 16:18:22 +0000
commit9a75d7cbc56ad9dba085d32971bd95e880c1319d (patch)
tree7869b79722da75bb3ecc6d470e8861a512ca36c4
parenteccec14140613e0ae58b967f839368c648559eee (diff)
downloadcpython-9a75d7cbc56ad9dba085d32971bd95e880c1319d.tar.gz
Document the new additional signature for utime(). In addition to the
previous functionality utime(path, (atime, mtime)), now allowed is utime(path, None) which sets the file's times to the current time.
-rw-r--r--Doc/lib/libos.tex9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index 4001447f35..0fb8f10185 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -702,9 +702,12 @@ Remove the file \var{path}. This is the same function as
Availability: Macintosh, \UNIX{}, Windows.
\end{funcdesc}
-\begin{funcdesc}{utime}{path, (atime, mtime)}
-Set the access and modified time of the file to the given values.
-(The second argument is a tuple of two items.)
+\begin{funcdesc}{utime}{path, times}
+Set the access and modified times of the file specified by \var{path}.
+If \var{times} is \code{None}, then the file's access and modified
+times are set to the current time. Otherwise, \var{times} must be a
+2-tuple of numbers, of the form \var{(atime, mtime)} which is used to
+set the access and modified times, respectively.
Availability: Macintosh, \UNIX{}, Windows.
\end{funcdesc}