rust-lang/rust-clippy

doc_markdown a bit too eager

Open

#902 ouverte le 5 mai 2016

Voir sur GitHub
 (10 commentaires) (0 réactions) (0 assignés)Rust (1 391 forks)batch import
S-needs-discussiongood first issue

Métriques du dépôt

Stars
 (10 406 stars)
Métriques de merge PR
 (Merge moyen 19j 22h) (113 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Ajustez le lint doc markdown pour éviter d'avertir sur les URL YouTube en vérifiant si le contenu entre backticks est une URL.
Stack technique
rust
Domaine
developer experiencetooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70