summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2003-09-04 18:29:53 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2003-09-04 18:29:53 (GMT)
commitef36537b81306fa89dfb75a58b209c64126998d0 (patch)
treebc0c2b791f6bade3084559a4645ad0a6b9c8ae9d
parentf5b93736a2eb5fb44e36379b0c998bdaae69f6ef (diff)
downloadcpython-ef36537b81306fa89dfb75a58b209c64126998d0.zip
cpython-ef36537b81306fa89dfb75a58b209c64126998d0.tar.gz
cpython-ef36537b81306fa89dfb75a58b209c64126998d0.tar.bz2
Patch #792338: Correct documentation for timetuple return type.
-rw-r--r--Doc/lib/libdatetime.tex14
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/lib/libdatetime.tex b/Doc/lib/libdatetime.tex
index 1d61873..e97d11f 100644
--- a/Doc/lib/libdatetime.tex
+++ b/Doc/lib/libdatetime.tex
@@ -428,15 +428,15 @@ Instance methods:
\end{methoddesc}
\begin{methoddesc}{timetuple}{}
- Return a 9-element tuple of the form returned by
+ Return a \class{time.struct_time} such as returned by
\function{time.localtime()}. The hours, minutes and seconds are
0, and the DST flag is -1.
\code{\var{d}.timetuple()} is equivalent to
- \code{(\var{d}.year, \var{d}.month, \var{d}.day,
+ \code{time.struct_time((\var{d}.year, \var{d}.month, \var{d}.day,
0, 0, 0,
\var{d}.weekday(),
\var{d}.toordinal() - date(\var{d}.year, 1, 1).toordinal() + 1,
- -1)}
+ -1))}
\end{methoddesc}
\begin{methoddesc}{toordinal}{}
@@ -858,14 +858,14 @@ Instance methods:
\end{methoddesc}
\begin{methoddesc}{timetuple}{}
- Return a 9-element tuple of the form returned by
+ Return a \class{time.struct_time} such as returned by
\function{time.localtime()}.
\code{\var{d}.timetuple()} is equivalent to
- \code{(\var{d}.year, \var{d}.month, \var{d}.day,
+ \code{time.struct_time((\var{d}.year, \var{d}.month, \var{d}.day,
\var{d}.hour, \var{d}.minute, \var{d}.second,
\var{d}.weekday(),
\var{d}.toordinal() - date(\var{d}.year, 1, 1).toordinal() + 1,
- dst)}
+ dst))}
The \member{tm_isdst} flag of the result is set according to
the \method{dst()} method: \member{tzinfo} is \code{None} or
\method{dst()} returns \code{None},
@@ -881,7 +881,7 @@ Instance methods:
for a UTC time.
If \var{d} is aware, \var{d} is normalized to UTC time, by subtracting
- \code{\var{d}.utcoffset()}, and a timetuple for the
+ \code{\var{d}.utcoffset()}, and a \class{time.struct_time} for the
normalized time is returned. \member{tm_isdst} is forced to 0.
Note that the result's \member{tm_year} member may be
\constant{MINYEAR}-1 or \constant{MAXYEAR}+1, if \var{d}.year was