rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1,136 opened on Aug 5, 2016

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Rust (10,406 stars) (1,391 forks)batch import
C-enhancementgood first issue

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.

Contributor guide

Tech stack
rust
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust basicsclippy architecturelint implementation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requires modifying the doc markdown lint in clippy to ignore strings that are acronyms (e.g., DirectX, OpenGL). The logic should treat such strings as not requiring backticks. The implementation should be in the lint's code, likely in `clippy lints/src/doc.rs`. There is a comment suggesting to check if a word is all caps with a single lowercase letter at the end? Actually the issue says for camel case it should have at least two camelcase words each with at least one lowercase letter. So the fix is to adjust the camel case detection to exclude strings that are just acronyms (all caps or with a lowercase ending?). The contributor should explore the existing doc markdown implementation and add a condition to skip words that consist only of uppercase letters or have a single trailing lowercase letter (like DirectX). Look at existing tests in `tests/ui/doc.rs` for reference.