From: Fred Drake <fdrake@acm.org>
Date: Fri, 11 Aug 2000 17:37:33 +0000 (+0000)
Subject: Added material about documenting packages, so that the use of module
X-Git-Tag: v2.0b1~508
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7932ed0ac4fb3db990ebffce0d281865d680a10e;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 33cc44389704..7b7f1574b3a1 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -610,6 +610,26 @@ distribution, to create or maintain whole documents or sections.
 \moduleauthor{Jane Doe}{jane.doe@frobnitz.org}
 \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},
     \samp{builtin}, \samp{extension}, or \samp{}), and the module