rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1.136 aberto em 5 de ago. de 2016

Ver no GitHub
 (5 comments) (2 reactions) (0 assignees)Rust (1.391 forks)batch import
C-enhancementgood first issue

Métricas do repositório

Stars
 (10.406 stars)
Métricas de merge de PR
 (Mesclagem média 19d 22h) (113 fundiu PRs em 30d)

Description

Instead of needing to manually whitelist, we should ignore things like DirectX and OpenGL. For something to be camel case, it should have at least two camelcase words in it, each which have at least one lowercase letter.

Guia do colaborador

Direção de pesquisa
A questão requer a modificação do lint doc markdown no clippy para ignorar strings que são acrônimos (por exemplo, DirectX, OpenGL). A lógica deve tratar tais strings como não requerendo crases. A implementação deve estar no código do lint, provavelmente em `clippy lints/src/doc.rs`. Há um comentário sugerindo verificar se uma palavra está toda em maiúsculas com uma única letra minúscula no final? Na verdade, a questão diz que para camel case deve ter pelo menos duas palavras em camel case, cada uma com pelo menos uma letra minúscula. Portanto, a correção é ajustar a detecção de camel case para excluir strings que são apenas acrônimos (todas maiúsculas ou com uma minúscula no final?). O contribuidor deve explorar a implementação existente do doc markdown e adicionar uma condição para pular palavras que consistem apenas em letras maiúsculas ou têm uma única letra minúscula no final (como DirectX). Consulte os testes existentes em `tests/ui/doc.rs` para referência.
Pilha de tecnologia
rust
Domain
developer experiencetooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
RustGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70