Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7932ed0

Browse files
committed
Added material about documenting packages, so that the use of module
markup for packages is clear.
1 parent f407063 commit 7932ed0

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

Doc/doc/doc.tex

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,26 @@ \section{\module{spam} ---
610610
\moduleauthor{Jane Doe}{[email protected]}
611611
\end{verbatim}
612612

613+
Python packages\index{packages} --- collections of modules that can
614+
be described as a unit --- are documented using the same markup as
615+
modules. The name for a module in a package should be typed in
616+
``fully qualified'' form (i.e., it should include the package name).
617+
For example, a module ``foo'' in package ``bar'' should be marked as
618+
\samp{\e module\{bar.foo\}}, and the beginning of the reference
619+
section would appear as:
620+
621+
\begin{verbatim}
622+
\section{\module{bar.foo} ---
623+
Module from the \module{bar} package}
624+
625+
\declaremodule{extension}{bar.foo}
626+
\modulesynopsis{Nifty module from the \module{bar} package.}
627+
\moduleauthor{Jane Doe}{[email protected]}
628+
\end{verbatim}
629+
630+
Note that the name of a package is also marked using
631+
\macro{module}.
632+
613633
\begin{macrodesc}{declaremodule}{\op{key}\p{type}\p{name}}
614634
Requires two parameters: module type (\samp{standard},
615635
\samp{builtin}, \samp{extension}, or \samp{}), and the module

0 commit comments

Comments
 (0)