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