rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1,136 opened on Aug 5, 2016

View on GitHubContributor guide
 (5 comments) (2 reactions) (0 assignees)Rust (1,391 forks)batch import
C-enhancementgood first issue

Repository metrics

Stars
 (10,406 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Investigate the current whitelist mechanism in the doc markdown lint and modify the check to skip words that are entirely uppercase or consist only of acronyms (e.g., DirectX, OpenGL) by ensuring that at least two camelCase words with lowercase letters are present for detection.
Tech stack
rust
Domain
developer experiencetooling
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70