[Python-checkins] python/dist/src/Doc/doc doc.tex,1.60,1.61

[fdrake@sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory usw-pr-cvs1:/tmp/cvs-serv13439/doc

Modified Files:
	doc.tex 
Log Message:
Document the \csimplemacro macro and the csimplemacrodesc environment.

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.60
retrieving revision 1.61
diff -C2 -d -r1.60 -r1.61
*** doc.tex	13 Mar 2002 02:48:24 -0000	1.60
--- doc.tex	9 Apr 2002 20:17:42 -0000	1.61
***************
*** 550,553 ****
--- 550,563 ----
      \end{envdesc}
  
+     \begin{envdesc}{csimplemacrodesc}{\p{name}}
+       Documentation for a ``simple'' macro.  Simple macros are macros
+       which are used for code expansion, but which do not take
+       arguments so cannot be described as functions.  This is not to
+       be used for simple constant definitions.  Examples of it's use
+       in the Python documentation include
+       \csimplemacro{PyObject_HEAD} and
+       \csimplemacro{Py_BEGIN_ALLOW_THREADS}.
+     \end{envdesc}
+ 
      \begin{envdesc}{ctypedesc}{\op{tag}\p{name}}
        Environment used to described a C type.  The \var{name}
***************
*** 734,737 ****
--- 744,757 ----
        \code{\#define} or a Python variable that is not intended to be
        changed.
+     \end{macrodesc}
+ 
+     \begin{macrodesc}{csimplemacro}{\p{name}}
+       The name of a ``simple'' macro.  Simple macros are macros
+       which are used for code expansion, but which do not take
+       arguments so cannot be described as functions.  This is not to
+       be used for simple constant definitions.  Examples of it's use
+       in the Python documentation include
+       \csimplemacro{PyObject_HEAD} and
+       \csimplemacro{Py_BEGIN_ALLOW_THREADS}.
      \end{macrodesc}