rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1,136 创建于 2016年8月5日

在 GitHub 查看
 (5 评论) (2 反应) (0 负责人)Rust (1,391 fork)batch import
C-enhancementgood first issue

仓库指标

Star
 (10,406 star)
PR 合并指标
 (平均合并 19天 22小时) (30 天内合并 113 个 PR)

描述

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.

贡献者指南

研究方向
该问题要求修改 clippy 中的 doc markdown lint，使其忽略作为首字母缩略词的字符串（例如 DirectX、OpenGL）。逻辑上应将此类字符串视为不需要反引号。实现应在该 lint 的代码中，很可能在 `clippy lints/src/doc.rs` 中。有一条评论建议检查一个单词是否全部大写且末尾有一个小写字母？实际上，问题说明对于驼峰命名法，它应至少包含两个驼峰词，每个词至少有一个小写字母。因此，修复方法是调整驼峰命名检测，以排除那些仅仅是首字母缩略词的字符串（全大写或末尾带一个小写字母？）。贡献者应探索现有的 doc markdown 实现，并添加一个条件来跳过仅由大写字母组成或末尾有单个小写字母（如 DirectX）的单词。可参考 `tests/ui/doc.rs` 中的现有测试。
技术栈
rust
领域
developer experiencetooling
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
RustGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70