rust-lang/rust-clippy

doc_markdown a bit too eager

Open

#902 opened on 2016年5月5日

GitHub で見る
 (10 comments) (0 reactions) (0 assignees)Rust (10,406 stars) (1,391 forks)batch import
S-needs-discussiongood first issue

説明

Running the latest clippy on https://github.com/Keats/tera/ gives the following warning:

Compiling tera v0.1.0 (file:///home/vincent/Code/tera)
src/lexer.rs:133:1: 133:94 warning: you should put `HxaD_trXwRE` between ticks in the documentation, #[warn(doc_markdown)] on by default
src/lexer.rs:133 /// Lexer based on the one used in go templates (https://www.youtube.com/watch?v=HxaD_trXwRE)
                 ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/lexer.rs:133:1: 133:94 help: for further information visit https://github.com/Manishearth/rust-clippy/wiki#doc_markdown

コントリビューターガイド

技術スタック
rust
領域
tooling
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Rust programmingfamiliarity with clippy lint system
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
Check the current implementation of the `doc markdown` lint in `clippy lints/src/doc markdown.rs`. The issue is that it incorrectly flags URLs with underscores as missing backticks. The fix should ensure that URLs are not flagged. Look at how other lints handle URLs or add a check for URL patterns.