summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2003-07-16 19:46:07 (GMT)
committerSkip Montanaro <skip@pobox.com>2003-07-16 19:46:07 (GMT)
commit2491cd98c46f10ccfb3285122da36bbd9f181e9e (patch)
tree6ec6c78ef0f441e6a39dbf2c95ceaeb2285c5080
parent4d6e8fe5d13a313314550d7ebffafaf62dea1df2 (diff)
downloadcpython-2491cd98c46f10ccfb3285122da36bbd9f181e9e.zip
cpython-2491cd98c46f10ccfb3285122da36bbd9f181e9e.tar.gz
cpython-2491cd98c46f10ccfb3285122da36bbd9f181e9e.tar.bz2
expose the C API subsection which was hidden from LaTeX in a comment. In
the info conversion the \comment LaTeX macro mapped to a Texinfo @ignore macro. Unfortunately, py2texi.el is not smart enough to avoid generating links to the @ignore'd section, which causes makeinfo to croak. Exposing this text is probably not the most correct thing to do, as this documentation really belongs in the C API manual. This does get the info files generated, however, which is a more practical goal considering the impending release of 2.3rc1.
-rw-r--r--Doc/lib/libdatetime.tex49
1 files changed, 27 insertions, 22 deletions
diff --git a/Doc/lib/libdatetime.tex b/Doc/lib/libdatetime.tex
index a0c2788..2151854 100644
--- a/Doc/lib/libdatetime.tex
+++ b/Doc/lib/libdatetime.tex
@@ -1400,20 +1400,21 @@ varies across platforms. Regardless of platform, years before 1900
cannot be used.
-\begin{comment}
-
\subsection{C API}
Struct typedefs:
+\begin{verbatim}
PyDateTime_Date
PyDateTime_DateTime
PyDateTime_Time
PyDateTime_Delta
PyDateTime_TZInfo
+\end{verbatim}
Type-check macros:
+\begin{verbatim}
PyDate_Check(op)
PyDate_CheckExact(op)
@@ -1428,27 +1429,31 @@ Type-check macros:
PyTZInfo_Check(op)
PyTZInfo_CheckExact(op)
+\end{verbatim}
Accessor macros:
All objects are immutable, so accessors are read-only. All macros
-return ints:
-
- For \class{date} and \class{datetime} instances:
- PyDateTime_GET_YEAR(o)
- PyDateTime_GET_MONTH(o)
- PyDateTime_GET_DAY(o)
-
- For \class{datetime} instances:
- PyDateTime_DATE_GET_HOUR(o)
- PyDateTime_DATE_GET_MINUTE(o)
- PyDateTime_DATE_GET_SECOND(o)
- PyDateTime_DATE_GET_MICROSECOND(o)
-
- For \class{time} instances:
- PyDateTime_TIME_GET_HOUR(o)
- PyDateTime_TIME_GET_MINUTE(o)
- PyDateTime_TIME_GET_SECOND(o)
- PyDateTime_TIME_GET_MICROSECOND(o)
-
-\end{comment}
+return ints. For \class{date} and \class{datetime} instances:
+\begin{verbatim}
+ PyDateTime_GET_YEAR(o)
+ PyDateTime_GET_MONTH(o)
+ PyDateTime_GET_DAY(o)
+\end{verbatim}
+
+For \class{datetime} instances:
+\begin{verbatim}
+ PyDateTime_DATE_GET_HOUR(o)
+ PyDateTime_DATE_GET_MINUTE(o)
+ PyDateTime_DATE_GET_SECOND(o)
+ PyDateTime_DATE_GET_MICROSECOND(o)
+\end{verbatim}
+
+For \class{time} instances:
+\begin{verbatim}
+ PyDateTime_TIME_GET_HOUR(o)
+ PyDateTime_TIME_GET_MINUTE(o)
+ PyDateTime_TIME_GET_SECOND(o)
+ PyDateTime_TIME_GET_MICROSECOND(o)
+\end{verbatim}
+