Commit 0f8e5431 authored by Fred Drake's avatar Fred Drake

- use classdesc where we can (for better indexing)

- more style consistency crud
parent 18565411
...@@ -136,7 +136,7 @@ object ...@@ -136,7 +136,7 @@ object
A \class{timedelta} object represents a duration, the difference A \class{timedelta} object represents a duration, the difference
between two dates or times. between two dates or times.
\begin{funcdesc}{timedelta}{days=0, seconds=0, microseconds=0, \begin{classdesc}{timedelta}{days=0, seconds=0, microseconds=0,
milliseconds=0, minutes=0, hours=0, weeks=0} milliseconds=0, minutes=0, hours=0, weeks=0}
All arguments are optional. Arguments may be ints, longs, or floats, All arguments are optional. Arguments may be ints, longs, or floats,
...@@ -178,19 +178,25 @@ A week is converted to 7 days. ...@@ -178,19 +178,25 @@ A week is converted to 7 days.
>>> (d.days, d.seconds, d.microseconds) >>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999) (-1, 86399, 999999)
\end{verbatim} \end{verbatim}
\end{funcdesc} \end{classdesc}
Class attributes are: Class attributes are:
\begin{tableii}{c|l}{code}{Attribute}{Value} \begin{memberdesc}{min}
\lineii{min}{The most negative \class{timedelta} object, The most negative \class{timedelta} object,
\code{timedelta(-999999999)}} \code{timedelta(-999999999)}.
\lineii{max}{The most positive \class{timedelta} object, \end{memberdesc}
timedelta(days=999999999, hours=23, minutes=59, seconds=59,
microseconds=999999)} \begin{memberdesc}{max}
\lineii{resolution}{The smallest possible difference between non-equal The most positive \class{timedelta} object,
\class{timedelta} objects, \code{timedelta(microseconds=1)}} \code{timedelta(days=999999999, hours=23, minutes=59, seconds=59,
\end{tableii} microseconds=999999)}.
\end{memberdesc}
\begin{memberdesc}{resolution}
The smallest possible difference between non-equal
\class{timedelta} objects, \code{timedelta(microseconds=1)}.
\end{memberdesc}
Note that, because of normalization, \code{timedelta.max} \textgreater Note that, because of normalization, \code{timedelta.max} \textgreater
\code{-timedelta.min}. \code{-timedelta.max} is not representable as \code{-timedelta.min}. \code{-timedelta.max} is not representable as
...@@ -277,7 +283,7 @@ directions. January 1 of year 1 is called day number 1, January 2 of year ...@@ -277,7 +283,7 @@ directions. January 1 of year 1 is called day number 1, January 2 of year
computations. See the book for algorithms for converting between computations. See the book for algorithms for converting between
proleptic Gregorian ordinals and many other calendar systems. proleptic Gregorian ordinals and many other calendar systems.
\begin{funcdesc}{date}{year, month, day} \begin{classdesc}{date}{year, month, day}
All arguments are required. Arguments may be ints or longs, in the All arguments are required. Arguments may be ints or longs, in the
following ranges: following ranges:
...@@ -289,7 +295,7 @@ proleptic Gregorian ordinals and many other calendar systems. ...@@ -289,7 +295,7 @@ proleptic Gregorian ordinals and many other calendar systems.
If an argument outside those ranges is given, \exception{ValueError} If an argument outside those ranges is given, \exception{ValueError}
is raised. is raised.
\end{funcdesc} \end{classdesc}
Other constructors, all class methods: Other constructors, all class methods:
...@@ -487,7 +493,7 @@ calendar extended in both directions; like a time object, ...@@ -487,7 +493,7 @@ calendar extended in both directions; like a time object,
\class{datetime} assumes there are exactly 3600*24 seconds in every \class{datetime} assumes there are exactly 3600*24 seconds in every
day. day.
\begin{funcdesc}{datetime}{year, month, day, \begin{classdesc}{datetime}{year, month, day,
hour=0, minute=0, second=0, microsecond=0} hour=0, minute=0, second=0, microsecond=0}
The year, month and day arguments are required. Arguments may be The year, month and day arguments are required. Arguments may be
ints or longs, in the following ranges: ints or longs, in the following ranges:
...@@ -504,7 +510,7 @@ day. ...@@ -504,7 +510,7 @@ day.
If an argument outside those ranges is given, \exception{ValueError} If an argument outside those ranges is given, \exception{ValueError}
is raised. is raised.
\end{funcdesc} \end{classdesc}
Other constructors, all class methods: Other constructors, all class methods:
...@@ -752,9 +758,9 @@ Instance methods: ...@@ -752,9 +758,9 @@ Instance methods:
A \class{time} object represents an idealized time of day, independent A \class{time} object represents an idealized time of day, independent
of day and timezone. of day and timezone.
\begin{funcdesc}{time}{hour=0, minute=0, second=0, microsecond=0} \begin{classdesc}{time}{hour=0, minute=0, second=0, microsecond=0}
All arguments are optional. They may be ints or longs, in the All arguments are optional. They may be ints or longs, in the
following ranges: following ranges:
\begin{itemize} \begin{itemize}
\item \code{0 <= \var{hour} < 24} \item \code{0 <= \var{hour} < 24}
...@@ -763,9 +769,9 @@ following ranges: ...@@ -763,9 +769,9 @@ following ranges:
\item \code{0 <= \var{microsecond} < 1000000} \item \code{0 <= \var{microsecond} < 1000000}
\end{itemize} \end{itemize}
If an argument outside those ranges is given, \exception{ValueError} is If an argument outside those ranges is given, \exception{ValueError}
raised. is raised.
\end{funcdesc} \end{classdesc}
Class attributes: Class attributes:
...@@ -948,21 +954,22 @@ particular day, and subject to adjustment via a \class{tzinfo} object. ...@@ -948,21 +954,22 @@ particular day, and subject to adjustment via a \class{tzinfo} object.
Constructor: Constructor:
\begin{funcdesc}{time}{hour=0, minute=0, second=0, microsecond=0, tzinfo=None} \begin{classdesc}{time}{hour=0, minute=0, second=0, microsecond=0,
tzinfo=None}
All arguments are optional. \var{tzinfo} may be \code{None}, or All arguments are optional. \var{tzinfo} may be \code{None}, or
an instance of a \class{tzinfo} subclass. The remaining arguments an instance of a \class{tzinfo} subclass. The remaining arguments
may be ints or longs, in the following ranges: may be ints or longs, in the following ranges:
\begin{itemize} \begin{itemize}
\item \code{0 <= \var{hour} < 24} \item \code{0 <= \var{hour} < 24}
\item \code{0 <= \var{minute} < 60} \item \code{0 <= \var{minute} < 60}
\item \code{0 <= \var{second} < 60} \item \code{0 <= \var{second} < 60}
\item \code{0 <= \var{microsecond} < 1000000}. \item \code{0 <= \var{microsecond} < 1000000}.
\end{itemize} \end{itemize}
If an argument outside those ranges is given, If an argument outside those ranges is given,
\exception{ValueError} is raised. \exception{ValueError} is raised.
\end{funcdesc} \end{classdesc}
Class attributes: Class attributes:
...@@ -1092,7 +1099,7 @@ from a \class{date} object and a \class{timetz} object. ...@@ -1092,7 +1099,7 @@ from a \class{date} object and a \class{timetz} object.
Constructor: Constructor:
\begin{funcdesc}{datetimetz}{year, month, day, \begin{classdesc}{datetimetz}{year, month, day,
hour=0, minute=0, second=0, microsecond=0, hour=0, minute=0, second=0, microsecond=0,
tzinfo=None} tzinfo=None}
The year, month and day arguments are required. \var{tzinfo} may The year, month and day arguments are required. \var{tzinfo} may
...@@ -1111,7 +1118,7 @@ Constructor: ...@@ -1111,7 +1118,7 @@ Constructor:
If an argument outside those ranges is given, If an argument outside those ranges is given,
\exception{ValueError} is raised. \exception{ValueError} is raised.
\end{funcdesc} \end{classdesc}
Other constructors (class methods): Other constructors (class methods):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment