Skip to content

Adicionar link para a linha do arquivo PO no alerta de lint - #317

Open
Filipcardos wants to merge 3 commits into
python:mainfrom
Filipcardos:link-lint-diagnostics
Open

Filipcardos wants to merge 3 commits into
python:mainfrom
Filipcardos:link-lint-diagnostics

Conversation

@Filipcardos

@Filipcardos Filipcardos commented Nov 11, 2026 •

Copy link
Copy Markdown

Os alertas de lint passam a mostrar o arquivo-fonte e a linha indicados nas referências da entrada PO, facilitando a busca por ocorrência no Transifex. Quando a referência não está disponível, a localização no PO é preservada.

Um único link para a revisão das traduções aparece no início do alerta. A mensagem respeita o limite de 4.096 unidades UTF-16 e aponta para o log completo quando há diagnósticos excedentes.

Validação local: referências simples e múltiplas, linha dentro da entrada, referências ausentes, diagnósticos duplicados, caminhos absolutos e 300 diagnósticos com emojis. Nenhuma mensagem foi enviada ao Telegram durante os testes.

Ref. #294.

@rffontenelle

Copy link
Copy Markdown
Collaborator

@Filipcardos Obrigado desde já por sua contribuição. Realmente o fato de usarmos Transifex e os avisos do sphinx-lint apontarem para um arquivo PO não ajuda mundo no fluxo de trabalho de tradução.

O único problema desta solução é que ela adiciona pelo menos 120 caracteres, para cada erro encontrado, a uma mensagem de Telegram que já é limitada a 4096 caracteres pelo Telegram. Dependendo da quantidade de erros e o tamanho das mensagens, o GitHub Action que envia mensagens para o Telegram vai simplesmente falhar ao invés enviar as mensagens (Sim, ele não trata esse problema e não temos hoje esse tipo de tratamento em nosso CI).

Uma solução menos custosa (em termos de consumo de caracteres da mensagem) seria substituir o nome do arquivo PO e sua linha pelo nome do arquivo-fonte e respectiva linha. O sphinx-lint executado contra arquivos PO aponta a primeira linha do combo linha de arquivo-fonte + msgid + msgstr. Então, pegando a linha informada pelo sphinx-lint e substituindo na saída, pode ser mais útil (por exemplo para buscar a mensagem problemática no Transifex com o filtro de pesquisa occurrence:lineno). Por exemplo, em vez de aparecer bugs.po:29 na mensagem, aparecer bugs.rst:5 que é exatamente a mensagem referida pelo sphinx-lint (obs.: este não é um exemplo real, eu só causei o erro localmente para testar).

Outra solução menos custosa seria adicionar este mesmo link para o commit específico no repositório de tradução, mas apenas uma vez no início da mensagem, para a navegação no commit específico. Por exemplo "https://github.com/python/python-docs-pt-br/tree/d639a06899cc4660a18844fd8df9b53576b2b59d/" ou um hipertexto para este link. Assim, gera menos repetição de caracteres e ainda sim mantém um acesso fácil ao commit específico para acesso ao arquivo fonte na linha procurada.

O que acha dessas alterativas?

@Filipcardos

Copy link
Copy Markdown
Author

@rffontenelle Obrigado pela análise e pelas sugestões! Faz sentido evitar a repetição dos links, principalmente com o limite do Telegram.

Prefiro seguir com o nome do arquivo-fonte e a linha correspondente, como no exemplo bugs.rst:5, para facilitar a busca no Transifex. Podemos complementar com um único link para o commit no início da mensagem.

Vou ajustar a PR nessa direção e validar o tamanho dos alertas antes de pedir uma nova revisão. Obrigado por explicar esse detalhe do fluxo de tradução!

@Filipcardos

Copy link
Copy Markdown
Author

@rffontenelle Ajustei no commit ddc9ef8: os diagnósticos agora mostram o arquivo-fonte e a linha das referências da entrada PO, com um único link para a revisão no início do alerta. Quando não há referência disponível, mantenho a localização no PO.

Validei localmente referências simples e múltiplas, caminhos absolutos, diagnósticos repetidos e um log com 300 entradas incluindo emojis. A mensagem ficou dentro do limite de 4.096 unidades UTF-16, com indicação do log completo quando necessário. Não enviei mensagens ao Telegram nos testes.

Os workflows estão aguardando autorização de um mantenedor. Pode revisar novamente quando tiver disponibilidade? Obrigado!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants