Renderer.related_symbols
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1377.
Símbolos públicos realmente citados no texto, em ordem de ocorrência.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.
Assinatura e expansão
def related_symbols(self, text: str, limit: int = 18) -> list[Symbol]:
Parâmetros formais: self, text: str, limit: int.
Como funciona
Símbolos públicos realmente citados no texto, em ordem de ocorrência.
Implementação
def related_symbols(self, text: str, limit: int = 18) -> list[Symbol]:
"""Símbolos públicos realmente citados no texto, em ordem de ocorrência."""
found: dict[str, int] = {}
for name, candidates in self.inv.by_name.items():
if len(name) < 3 or not any(ch.isalpha() for ch in name):
continue
symbol = candidates[0]
public = (symbol.kind == "macro" and not self.macro_target(symbol)) or (
symbol.kind == "função C" and symbol.path.startswith(("include/", "src/")))
if not public:
continue
count = len(re.findall(r"(?<![\w])" + re.escape(name) + r"(?![\w])", text))
if count:
found[name] = count
ranked = sorted(found, key=lambda n: (-found[n], n))[:limit]
return [self.inv.by_name[n][0] for n in ranked]
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.related_symbols. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que Renderer.related_symbols faz?
Símbolos públicos realmente citados no texto, em ordem de ocorrência.
Qual é a assinatura e o tipo de retorno de Renderer.related_symbols?
Assinatura extraída de tools/documentacao/render.py; visibilidade pública.
def related_symbols(self, text: str, limit: int = 18) -> list[Symbol]:
Como chamar Renderer.related_symbols 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 related_symbols(self, text: str, limit: int = 18) -> list[Symbol]:
Por que não há teste direto para Renderer.related_symbols?
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.related_symbols depende de compilador, padrão C ou sistema operacional?
Renderer.related_symbols é 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.