rust-lang/rust-clippy

doc_markdown should ignore things which just contain acronyms

Open

#1,136 opened on 2016年8月5日

GitHub で見る
 (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
 (平均マージ 19d 22h) (30d で 113 merged PRs)

説明

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` にあります。コメントでは、単語がすべて大文字で末尾に1つの小文字があるかどうかをチェックすることを提案していますか？実際、問題ではキャメルケースの場合、少なくとも2つのキャメルケース単語があり、それぞれに少なくとも1つの小文字が必要とされています。したがって、修正はキャメルケースの検出を調整して、単なる頭字語（すべて大文字、または末尾に小文字が1つ付いているもの？）である文字列を除外することです。コントリビューターは既存の doc markdown の実装を調査し、大文字のみで構成されているか、末尾に単一の小文字（DirectX など）がある単語をスキップする条件を追加する必要があります。`tests/ui/doc.rs` の既存のテストを参考にしてください。
技術スタック
rust
領域
developer experiencetooling
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
RustGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70