Module

Breve descrição do módulo e do seu uso nos fluxos Marvin.

Opcional:

Importante

Somente funções decoradas com @decorators.robotaction aparecem aqui. Chaves de retorno viram variáveis de estado (use $nome_da_variavel no fluxo).

Tutorial ou configuração opcional

Use esta região para autenticação, pré-requisitos, capturas de ecrã ou passo a passo antes do catálogo de ações. Mantenha estes títulos ao nível ## para preservar a hierarquia.

O índice à direita (TOC) é gerado automaticamente pelos cabeçalhos — não adicione ## Índice nem listas de links manuais no corpo.

Ações

module.example_action

Parágrafo curto sobre comportamento e efeitos colaterais.

Parâmetros:

param_required - descrição; pode referenciar module.other_action.

param_optional (opcional) - valor por omissão e semântica.

Listas detalhadas são aceites quando acrescentam contexto:

param_a — detalhes.
param_b — detalhes.

Retornar:

Chaves e tipos devolvidos. Se não houver retorno, indique explicitamente.

Exceções:

Liste exceções ou escreva que a ação não lança exceções documentadas.

Exemplo de uso

script.mvn

result = module.example_action(param_required="x")
prompt.alert(str(result))

module.other_action

Segunda ação com os mesmos blocos.

Parâmetros:

input - descrição.

Retornar:

output_key - mapeado para $output_key no fluxo.

Exceções:

ValueError - quando a validação falha.

Resolução de problemas

Secções ## depois de ## Ações podem conter FAQ, desempenho ou notas de migração.

Convenções (checklist)

Use ## Ações e um ### **módulo.ação** {#âncora} por ação para o TOC à direita listar tudo (sem ## Índice manual no corpo).
Cabeçalhos: ### **nome.qualificado** {#nomequalificado} com âncora coerente com links internos (pontos removidos, minúsculas).
Blocos: ##### Parâmetros:, ##### Retornar:, ##### Exceções: (rótulos exatos).
Exemplos (??? example), imagens, tabelas e blocos de código mantêm-se onde forem úteis.
Mantenha a hierarquia de cabeçalhos (## para secções, ### por ação) para a navegação previsível.