{% extends "base.html.j2" %} {% import "components.html.j2" as ui %} {% block content %}

{{ doc.metadata.script_type or "Módulo interno" }} · {{ doc.metadata.description or "Documentación" }}

Módulo compartido / servicios internos

Referencia funcional del módulo compartido.

{{ ui.metadata_block(doc.metadata) }} {{ ui.summary_block(doc.summary) }} {# ------------------------ API pública ------------------------ #} {% if doc.api %}

API pública

{% for fn in doc.api %}

{{ fn.name }}

{{ fn.description }}

{# Parámetros: solo tabla si hay datos estructurados #} {% if fn.parameters %} {{ ui.table_block("Parámetros", fn.parameters, [ {"field": "name", "title": "Nombre"}, {"field": "description", "title": "Descripción"}, {"field": "type", "title": "Tipo"} ]) }} {% endif %} {% if fn.side_effects %} {{ ui.list_block("Efectos colaterales", fn.side_effects) }} {% endif %} {% if fn.returns %} {{ ui.logic_block("Retorna", fn.returns) }} {% endif %} {% endfor %}
{% endif %} {# ------------------------ Efectos generales del módulo ------------------------ #} {% if doc.side_effects %} {{ ui.list_block("Efectos colaterales", doc.side_effects) }} {% endif %} {# ------------------------ Errores ------------------------ #} {% if doc.errors %} {% if doc.errors is mapping %} {# Si algún día viene como objeto: usar list_block sobre sus partes #} {{ ui.list_block("Errores", doc.errors.explicit_checks or []) }} {{ ui.list_block("Manejo de excepciones", doc.errors.exception_handling or []) }} {% else %} {# Caso actual típico: lista simple de strings #} {{ ui.list_block("Errores", doc.errors) }} {% endif %} {% endif %} {# ------------------------ Detalles de implementación ------------------------ #} {% if doc.logic %} {{ ui.logic_block("Detalles de implementación", doc.logic) }} {% endif %} {% endblock %}