Renderer.document_extra
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1394.
Acrescenta a um documento importado os símbolos citados e o FAQ editorial.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.
Assinatura e expansão
def document_extra(self, key: str, text: str) -> str:
Parâmetros formais: self, key: str, text: str.
Como funciona
Acrescenta a um documento importado os símbolos citados e o FAQ editorial.
Implementação
def document_extra(self, key: str, text: str) -> str:
"""Acrescenta a um documento importado os símbolos citados e o FAQ editorial."""
out = []
symbols = self.related_symbols(text)
if symbols:
out.append("## Símbolos citados neste documento\n\n")
out.append("Nomes que aparecem literalmente no texto acima e que possuem página de "
"referência gerada do fonte:\n\n")
out.append(", ".join(self.link(symbol) for symbol in symbols) + ".\n\n")
entries = self.contracts.get("documentos", {}).get(key)
if entries:
items = []
for entry in entries:
items.append({"q": entry["q"], "a": entry.get("a", []),
"code": entry.get("code"), "lang": entry.get("lang", "c")})
out.append(self.faq(
"Perguntas frequentes sobre este documento, respondidas a partir do conteúdo "
"versionado e da referência gerada.", items))
return "".join(out)
Como este símbolo aparece nos testes
Nenhuma referência direta a este nome foi encontrada nos arquivos de teste. Isso pode ser esperado para guardas de inclusão, configuração ou código exercitado indiretamente; não é uma afirmação de cobertura zero.
Compiladores, padrão C e sistema operacional
Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.
- Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.
Perguntas frequentes
Perguntas reunidas a partir da definição, do contrato editorial e dos testes de Renderer.document_extra. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que Renderer.document_extra faz?
Acrescenta a um documento importado os símbolos citados e o FAQ editorial.
Qual é a assinatura e o tipo de retorno de Renderer.document_extra?
Assinatura extraída de tools/documentacao/render.py; visibilidade pública.
def document_extra(self, key: str, text: str) -> str:
Como chamar Renderer.document_extra corretamente?
Nenhum exemplo editorial nem chamada direta em teste foi localizada. A forma de uso é a assinatura acima; os chamadores aparecem na seção de evidência indireta quando existem.
def document_extra(self, key: str, text: str) -> str:
Por que não há teste direto para Renderer.document_extra?
A busca estática não encontrou o identificador nos arquivos de teste. Isso é esperado para guardas de inclusão, configuração de build e nomes alcançados apenas por chamadores internos. O JSON de cobertura registra a lacuna em vez de convertê-la em aprovação.
Renderer.document_extra depende de compilador, padrão C ou sistema operacional?
Renderer.document_extra é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.
O que acontece em caso de falha ou uso inválido?
Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.