rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1.136 geöffnet am 5. Aug. 2016

Auf GitHub ansehen
 (5 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Rust (1.391 Forks)batch import
C-enhancementgood first issue

Repository-Metriken

Stars
 (10.406 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 19T 22h) (113 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Das Problem erfordert die Änderung des doc markdown Lints in clippy, um Zeichenketten zu ignorieren, die Akronyme sind (z. B. DirectX, OpenGL). Die Logik sollte solche Zeichenketten als nicht backticks erfordernd behandeln. Die Implementierung sollte im Code des Lints erfolgen, wahrscheinlich in `clippy lints/src/doc.rs`. Es gibt einen Kommentar, der vorschlägt, zu prüfen, ob ein Wort nur aus Großbuchstaben besteht und am Ende einen einzelnen Kleinbuchstaben hat? Tatsächlich besagt das Problem, dass für Camel Case mindestens zwei Camel Case Wörter vorhanden sein müssen, von denen jedes mindestens einen Kleinbuchstaben hat. Daher besteht die Lösung darin, die Camel Case Erkennung anzupassen, um Zeichenketten auszuschließen, die nur Akronyme sind (nur Großbuchstaben oder mit einem Kleinbuchstaben am Ende?). Der Mitwirkende sollte die bestehende doc markdown Implementierung untersuchen und eine Bedingung hinzufügen, um Wörter zu überspringen, die nur aus Großbuchstaben bestehen oder einen einzelnen Kleinbuchstaben am Ende haben (wie DirectX). Siehe die vorhandenen Tests in `tests/ui/doc.rs` als Referenz.
Tech Stack
rust
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
RustGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70