[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.23,1.24

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory slayer.i.sourceforge.net:/tmp/cvs-serv13076/doc

Modified Files:
	doc.tex 
Log Message:

Added material about documenting packages, so that the use of module
markup for packages is clear.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -r1.23 -r1.24
*** doc.tex	2000/07/25 19:27:17	1.23
--- doc.tex	2000/08/11 17:37:33	1.24
***************
*** 611,614 ****
--- 611,634 ----
  \end{verbatim}
  
+   Python packages\index{packages} --- collections of modules that can
+   be described as a unit --- are documented using the same markup as
+   modules.  The name for a module in a package should be typed in
+   ``fully qualified'' form (i.e., it should include the package name).
+   For example, a module ``foo'' in package ``bar'' should be marked as
+   \samp{\e module\{bar.foo\}}, and the beginning of the reference
+   section would appear as:
+ 
+ \begin{verbatim}
+ \section{\module{bar.foo} ---
+          Module from the \module{bar} package}
+ 
+ \declaremodule{extension}{bar.foo}
+ \modulesynopsis{Nifty module from the \module{bar} package.}
+ \moduleauthor{Jane Doe}{jane.doe@frobnitz.org}
+ \end{verbatim}
+ 
+   Note that the name of a package is also marked using
+   \macro{module}.
+ 
    \begin{macrodesc}{declaremodule}{\op{key}\p{type}\p{name}}
      Requires two parameters: module type (\samp{standard},