rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1 136 ouverte le 5 août 2016

Voir sur GitHub
 (5 commentaires) (2 réactions) (0 assignés)Rust (1 391 forks)batch import
C-enhancementgood first issue

Métriques du dépôt

Stars
 (10 406 stars)
Métriques de merge PR
 (Merge moyen 19j 22h) (113 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Le problème nécessite de modifier le lint doc markdown dans clippy pour ignorer les chaînes qui sont des acronymes (par exemple DirectX, OpenGL). La logique doit traiter ces chaînes comme ne nécessitant pas de backticks. L'implémentation doit être dans le code du lint, probablement dans `clippy lints/src/doc.rs`. Il y a un commentaire suggérant de vérifier si un mot est entièrement en majuscules avec une seule lettre minuscule à la fin ? En fait, le problème indique que pour le camel case, il doit y avoir au moins deux mots en camel case, chacun avec au moins une lettre minuscule. La correction consiste donc à ajuster la détection du camel case pour exclure les chaînes qui ne sont que des acronymes (toutes majuscules ou avec une minuscule à la fin ?). Le contributeur doit explorer l'implémentation existante de doc markdown et ajouter une condition pour ignorer les mots qui ne contiennent que des lettres majuscules ou qui ont une seule lettre minuscule à la fin (comme DirectX). Consultez les tests existants dans `tests/ui/doc.rs` pour référence.
Stack technique
rust
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70