summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Doc/lib/librfc822.tex10
-rw-r--r--Doc/librfc822.tex10
2 files changed, 18 insertions, 2 deletions
diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex
index 1374755..4e65e91 100644
--- a/Doc/lib/librfc822.tex
+++ b/Doc/lib/librfc822.tex
@@ -40,13 +40,21 @@ returned.
\end{funcdesc}
\begin{funcdesc}{parsedate_tz}{date}
-Performs the same function as \code{parsedate}, but returns either
+Performs the same function as \code{parsedate()}, but returns either
\code{None} or a 10-tuple; the first 9 elements make up a tuple that
can be passed directly to \code{time.mktime()}, and the tenth is the
offset of the date's time zone from UTC (which is the official term
for Greenwich Mean Time).
\end{funcdesc}
+\begin{funcdesc}{mktime_tz}{tuple}
+Turn a 10-tuple as returned by \code{parsedate_tz()} into a UTC timestamp.
+Minor deficiency: this first interprets the first 8 elements as a
+local time and then compensates for the timezone difference;
+this may yield a slight error around daylight savings time
+switch dates. Not enough to worry about for common use.
+\end{funcdesc}
+
\subsection{Message Objects}
A \code{Message} instance has the following methods:
diff --git a/Doc/librfc822.tex b/Doc/librfc822.tex
index 1374755..4e65e91 100644
--- a/Doc/librfc822.tex
+++ b/Doc/librfc822.tex
@@ -40,13 +40,21 @@ returned.
\end{funcdesc}
\begin{funcdesc}{parsedate_tz}{date}
-Performs the same function as \code{parsedate}, but returns either
+Performs the same function as \code{parsedate()}, but returns either
\code{None} or a 10-tuple; the first 9 elements make up a tuple that
can be passed directly to \code{time.mktime()}, and the tenth is the
offset of the date's time zone from UTC (which is the official term
for Greenwich Mean Time).
\end{funcdesc}
+\begin{funcdesc}{mktime_tz}{tuple}
+Turn a 10-tuple as returned by \code{parsedate_tz()} into a UTC timestamp.
+Minor deficiency: this first interprets the first 8 elements as a
+local time and then compensates for the timezone difference;
+this may yield a slight error around daylight savings time
+switch dates. Not enough to worry about for common use.
+\end{funcdesc}
+
\subsection{Message Objects}
A \code{Message} instance has the following methods: