summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libtime.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-08-03 17:58:55 (GMT)
committerFred Drake <fdrake@acm.org>2004-08-03 17:58:55 (GMT)
commitf901abdd62c9067f993b85392dbb73a560af6325 (patch)
tree70cedeab8d5d6b1999a7bfcbd1bb0045c9aa0b90 /Doc/lib/libtime.tex
parentd04573fef0346ee9a131e0c63d18ab9fbd12ea63 (diff)
downloadcpython-f901abdd62c9067f993b85392dbb73a560af6325.zip
cpython-f901abdd62c9067f993b85392dbb73a560af6325.tar.gz
cpython-f901abdd62c9067f993b85392dbb73a560af6325.tar.bz2
allow ctime(), gmtime(), and localtime() to take None as equivalent to an omitted arg
(closes SF bug #658254, patch #663482)
Diffstat (limited to 'Doc/lib/libtime.tex')
-rw-r--r--Doc/lib/libtime.tex25
1 files changed, 17 insertions, 8 deletions
diff --git a/Doc/lib/libtime.tex b/Doc/lib/libtime.tex
index 04d02fb..f21f6a3 100644
--- a/Doc/lib/libtime.tex
+++ b/Doc/lib/libtime.tex
@@ -157,11 +157,14 @@ The resolution is typically better than one microsecond.
\begin{funcdesc}{ctime}{\optional{secs}}
Convert a time expressed in seconds since the epoch to a string
-representing local time. If \var{secs} is not provided, the current time
-as returned by \function{time()} is used. \code{ctime(\var{secs})}
-is equivalent to \code{asctime(localtime(\var{secs}))}.
+representing local time. If \var{secs} is not provided or
+\constant{None}, the current time as returned by \function{time()} is
+used. \code{ctime(\var{secs})} is equivalent to
+\code{asctime(localtime(\var{secs}))}.
Locale information is not used by \function{ctime()}.
\versionchanged[Allowed \var{secs} to be omitted]{2.1}
+\versionchanged[If \var{secs} is \constant{None}, the current time is
+ used]{2.3}
\end{funcdesc}
\begin{datadesc}{daylight}
@@ -171,16 +174,22 @@ Nonzero if a DST timezone is defined.
\begin{funcdesc}{gmtime}{\optional{secs}}
Convert a time expressed in seconds since the epoch to a \class{struct_time}
in UTC in which the dst flag is always zero. If \var{secs} is not
-provided, the current time as returned by \function{time()} is used.
-Fractions of a second are ignored. See above for a description of the
-\class{struct_time} object.
+provided or \constant{None}, the current time as returned by
+\function{time()} is used. Fractions of a second are ignored. See
+above for a description of the \class{struct_time} object.
\versionchanged[Allowed \var{secs} to be omitted]{2.1}
+\versionchanged[If \var{secs} is \constant{None}, the current time is
+ used]{2.3}
\end{funcdesc}
\begin{funcdesc}{localtime}{\optional{secs}}
-Like \function{gmtime()} but converts to local time. The dst flag is
-set to \code{1} when DST applies to the given time.
+Like \function{gmtime()} but converts to local time. If \var{secs} is
+not provided or \constant{None}, the current time as returned by
+\function{time()} is used. The dst flag is set to \code{1} when DST
+applies to the given time.
\versionchanged[Allowed \var{secs} to be omitted]{2.1}
+\versionchanged[If \var{secs} is \constant{None}, the current time is
+ used]{2.3}
\end{funcdesc}
\begin{funcdesc}{mktime}{t}