Documentar Python

Anterior: 5.5 Marcas en línea Niv. superior: 5 Marcaje especial Siguiente: 5.7 Marcas al nivel

---

5.6 Marcas específicas de módulos

\section{\module{magro} ---
         Acceso al servicio de MAGRO}

\declaremodule{extension}{magro}
  \platform{Unix}
\modulesynopsis{Acceso al servicio de MAGRO de \UNIX{}.}
\moduleauthor{Pepita Pérez Pérez}{pepita.perezperez@chimpanfonia.org}

Los paquetes de Python -- colecciones de módulos que se pueden describir como una unidad -- se documentan con las mismas marcas que los módulos. El nombre de un paquete de un módulo debe escribirse ``completamente calificado'' (es decir, debe incluir el nombre del paquete). Por ejemplo, el módulo ``cucu'' del paquete ``tras'' debe marcarse como "\module{cucu.tras}" y el principio de la sección de referencia aparecería así:

\section{\module{cucu.tras} ---
         Módulo del paquete \module{tras}}

\declaremodule{extensión}{cucu.tras}
\modulesynopsis{Fastuoso módulo del paquete \module{tras}.}
\moduleauthor{Pepita Pérez}{pepita.perezperez@chimpanfonia.org}

Observa que el nombre de un paquete también se marca con \module.

\declaremodule [clave]{tipo}{nombre}

Requiere dos parámetros: el tipo de módulo ("standard", "builtin", "extension" o "") y el nombre del módulo. Se debe dar un parámetro opcional como base de la ``clave'' del módulo utilizada para enlazar con, o hacer referencia a, la sección. La ``clave'' debe darse sólo si el nombre del módulo contiene caracteres de subrayado y debe ser el nombre sin los caracteres de subrayado. Observa que el parámetro tipo debe ser uno de los valores enumerados o se mostrará un mensaje de error. Para los módulos contenidos en paquetes, se debe dar el nombre completamente calificado como nombre. Esta declaración debe ser lo primero tras la \section utilizada para presentar el módulo.

\platform {especificaciones}

Especifica la portabilidad del módulo. especificaciones es una lista de claves separadas por comas que especifica en qué plataformas está disponible el módulo. Las claves son identificadores cortos. Las claves que se usan en la actualidad son: "IRIX", "Mac", "Windows" y "Unix". Es importante usar una clave ya utilizada cuando sea posible. Se utiliza para proporcionar anotaciones en el Índice de módulos y en las salidas a formato HTML y GNU info.

\modulesynopsis {texto}

texto es una breve descripción ``en una línea'' del módulo que se pueda usar como parte de la introducción al capítulo. Deba aparecer tras \declaremodule. La sinopsis se utiliza para construir el contenido de la tabla insertada como \localmoduletable. No se genera salida de texto en la ubicación de la marca.

\moduleauthor {nombre}{email}

Esta macro se usa para codificar información sobre quién es el autor de un módulo. Actualmente, no genera texto, pero ayuda a determinar el origen del módulo.

---

Documentar Python

Anterior: 5.5 Marcas en línea Niv. superior: 5 Marcaje especial Siguiente: 5.7 Marcas al nivel