From cd22dd79af0ab924caffbac2c139379842d00a76 Mon Sep 17 00:00:00 2001 From: Pierre-Olivier Mercier Date: Mon, 19 Jun 2023 17:58:39 +0200 Subject: [PATCH] Give some precisions on repochecker false-positives --- content/files/repochecker-ack.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/content/files/repochecker-ack.md b/content/files/repochecker-ack.md index 0df900a..f57868a 100644 --- a/content/files/repochecker-ack.md +++ b/content/files/repochecker-ack.md @@ -7,13 +7,11 @@ weight: 16 Dans le fichier `repochecker-ack.txt` se trouvant à la racine de votre dépôt, vous pourrez indiquer les faux-positifs retournés par `repochecker`. {{% notice info %}} -À l'heure actuelle, seules les erreurs de grammaire et d'orthographe bénéficient d'un système d'acquitement des faux-positifs.\ -Les autres tests doivent être pris au sérieux. +Toutes les erreurs remontées par `repochecker` ne bénéficient pas d'un mécanisme d'aquitement des faux-positifs. +Lorsqu'il peut s'agir d'un faux-positif, `repochecker` indique à la fin de la ligne d'erreur `(:anti-false-positive-string)`. {{% /notice %}} -`repochecker`, avec le plugin `grammalecte-rules.so`, vérifie la grammaire et l'orthographe des textes et des intitulés. - -Il est susceptible de retourner des erreurs telles que la suivante : +`repochecker` est susceptible de retourner des erreurs telles que la suivante : ``` 5-a-never-ending-cycle: overview.md: Confusion. La lieue est une unité de distance. Les lieus sont des poissons. (1:g3__conf_avoir_donner_lieu__b2_a1_1) @@ -22,7 +20,7 @@ Il est susceptible de retourner des erreurs telles que la suivante : Suggestion : lieu ``` -L'indication est donnée sur l'étape concernée (ici `5-a-never-ending-cycle`), sur le fichier dans lequel se trouve ce texte (ici `overview.md`). +L'indication est donnée sur l'étape de scénario concernée (ici `5-a-never-ending-cycle`), sur le fichier dans lequel se trouve ce texte (ici `overview.md`). Grammalecte détaille ensuite la faute avec un message explicite. La ligne se termine par un identifiant entre parenthèses (ici `1:g3__conf_avoir_donner_lieu__b2_a1_1`), dont on verra l'usage par la suite. @@ -45,7 +43,7 @@ Pour ignorer cette erreur, on indique dans le fichier `repochecker-ack.txt` : step-path/filename.md:paragraph-id:rule-id ``` -Avec `step-path/` l'éventuel chemin pour atteindre le fichier concerné, `filename.md` le nom du fichier dans lequel se trouve l'erreur, `paragraph-id` le numéro de paragraphe dans le fichier (commençant à 1) et `rule-id` l'identifiant de la règle Grammalecte que l'on souhaite ignorer. L'identifiant entre parenthèse à la fin de la première ligne renseigne sur le `paragraph-id:rule-id` +Avec `step-path/` **l'éventuel chemin** pour atteindre le fichier concerné depuis `repochecker-ack.txt` ; `filename.md` le nom du fichier dans lequel se trouve l'erreur, `paragraph-id` le numéro de paragraphe dans le fichier (commençant à 1) et `rule-id` l'identifiant de la règle Grammalecte que l'on souhaite ignorer. L'identifiant entre parenthèse à la fin de la première ligne renseigne sur le `paragraph-id:rule-id` Dans notre exemple, cela donnerait : @@ -53,6 +51,12 @@ Dans notre exemple, cela donnerait : 3-L'ascension de skyhacker​/challenge.txt:1:typo_espace_manquant_après3 ``` +Dans un dépôt d'exercice, ce serait : + +``` +challenge.txt:1:typo_espace_manquant_après3 +``` + ## Traiter les faux positifs orthographiques @@ -77,6 +81,14 @@ On indique alors dans le fichier `repochecker-ack.txt` : `*` désigne tous les fichiers (mais vous pouvez ignorer l'erreur que sur un fichier en particulier), `spelling:InformaSup` est l'identifiant de l'erreur tel que `repochecker` nous le donne. +{{% notice warning %}} +Nous vous demandons d'être le plus précis possible et de limiter l'usage du `*` aux cas strictement employés à de nombreuses reprises dans vos textes. +Lorsqu'il s'agit d'un faux-positif sporadique, précisez de quel fichier il s'agit. +Lorsque nous passerons en revu votre dépôt, nous vérifierons les faux-positifs que vous avez indiqués pour nous assurer que vous n'avez pas ajouté de non-faux-positif. +Nous devrons pour cela être capable d'aller voir rapidement le/les fichiers concernés. +Il n'est pas question pour nous de devoir partir à la recherche du mot dans tous les fichiers. +{{% /notice %}} + ## Gérer les passages en anglais