Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 026d962

Browse files
committed
Consistent spelling: "time zone" -> "timezone".
Clarify that the sign of the timezone offset returned by parsedate_tz() is the opposite of time.timezone.
1 parent 4186cd3 commit 026d962

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

Doc/lib/librfc822.tex

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ \section{Standard Module \sectcode{rfc822}}
4343
Performs the same function as \code{parsedate()}, but returns either
4444
\code{None} or a 10-tuple; the first 9 elements make up a tuple that
4545
can be passed directly to \code{time.mktime()}, and the tenth is the
46-
offset of the date's time zone from UTC (which is the official term
47-
for Greenwich Mean Time).
46+
offset of the date's timezone from UTC (which is the official term
47+
for Greenwich Mean Time). (Note that the sign of the timezone offset
48+
is the opposite of the sign of the \code{time.timezone} variable for
49+
the same timezone; the latter variable follows the \POSIX{} standard
50+
while this module follows \rfc{822}.)
4851
\end{funcdesc}
4952

5053
\begin{funcdesc}{mktime_tz}{tuple}
@@ -131,7 +134,7 @@ \subsection{Message Objects}
131134
Retrieve a header using \code{getheader} and parse it into a 10-tuple;
132135
the first 9 elements will make a tuple compatible with
133136
\code{time.mktime()}, and the 10th is a number giving the offset of
134-
the date's time zone from UTC. Similarly to \code{getdate()}, if
137+
the date's timezone from UTC. Similarly to \code{getdate()}, if
135138
there is no header matching \var{name}, or it is unparsable, return
136139
\code{None}.
137140
\end{funcdesc}

Doc/librfc822.tex

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ \section{Standard Module \sectcode{rfc822}}
4343
Performs the same function as \code{parsedate()}, but returns either
4444
\code{None} or a 10-tuple; the first 9 elements make up a tuple that
4545
can be passed directly to \code{time.mktime()}, and the tenth is the
46-
offset of the date's time zone from UTC (which is the official term
47-
for Greenwich Mean Time).
46+
offset of the date's timezone from UTC (which is the official term
47+
for Greenwich Mean Time). (Note that the sign of the timezone offset
48+
is the opposite of the sign of the \code{time.timezone} variable for
49+
the same timezone; the latter variable follows the \POSIX{} standard
50+
while this module follows \rfc{822}.)
4851
\end{funcdesc}
4952

5053
\begin{funcdesc}{mktime_tz}{tuple}
@@ -131,7 +134,7 @@ \subsection{Message Objects}
131134
Retrieve a header using \code{getheader} and parse it into a 10-tuple;
132135
the first 9 elements will make a tuple compatible with
133136
\code{time.mktime()}, and the 10th is a number giving the offset of
134-
the date's time zone from UTC. Similarly to \code{getdate()}, if
137+
the date's timezone from UTC. Similarly to \code{getdate()}, if
135138
there is no header matching \var{name}, or it is unparsable, return
136139
\code{None}.
137140
\end{funcdesc}

0 commit comments

Comments
 (0)