Skip to content

[doc] Écarts doc ↔ code : @return incomplet, section Dev du README figée à 0.4.2, Quick Start reposant sur le partial matching, restriction lazy des extraits non documentée #32

Description

@VincentGuyader

Contexte

Écarts factuels relevés entre la documentation et le code actuel :

  1. @return de compare_datasets_from_yaml : liste 7 éléments et omet all_passed — le premier élément réellement retourné. Décrit aussi agent comme « with validation results » alors qu'il n'est pas interrogé (c'est reponse qui l'est).
  2. README section « Dev part » (l.424-456) : compilée le 2026-03-11 sur datadiff 0.4.2 ; la couverture covr liste 7 fichiers R alors que R/ en compte 12 (coverage.R, fast_path.R, report.R, duplicate_keys.R absents). À régénérer ou retirer.
  3. README Quick Start (l.49) : appel sans key = qui ne fonctionne que via le partial matching $keys$key (cf. issue [bug] Résolution YAML vs arguments fragile : label écrasé silencieusement, champ « keys » lu par partial matching #20) ; la vignette passe toujours key explicitement. Le Quick Start impose par ailleurs le détour YAML alors que le mode zéro-config (path = NULL) existe et serait la meilleure première expérience.
  4. Vignette §14 : « By default, pointblank reports are rendered in English » — faux, le défaut est lang = "fr" (cf. issue [API] Surface d'export à assainir et contradictions NEWS : %||% ré-exporté, défaut lang="fr" non documenté, exports sans usage documenté #26).
  5. Vignette §extraits (post PR Réintroduire les écarts mesurés (__absdiff/__thresh) dans les extraits d'échec #12) : documente __absdiff/__thresh dans les extraits sans préciser la restriction chemin local uniquement que NEWS mentionne (le lazy n'a jamais ces diagnostics).
  6. read_rules() : stopifnot(r$version == 1) produit une erreur cryptique (« r$version == 1 is not TRUE ») pour un fichier utilisateur, et aucun champ inconnu du YAML n'est signalé (by_nmae: passe silencieusement) — la friction principale d'un package dont le YAML est édité à la main. write_rules_template() accepte en outre version = 2 que read_rules() refusera.

Critères de succès

  • @return exhaustif et exact (8 éléments, description d'agent corrigée) ; man/ régénéré.
  • Section Dev du README régénérée (ou supprimée) ; badges/couverture à jour.
  • Quick Start : exemple zéro-config d'abord, YAML ensuite ; key explicite partout.
  • Vignette : défaut de langue corrigé, restriction lazy des diagnostics d'extraits mentionnée.
  • read_rules() : erreur de version explicite (fichier + versions supportées) et warning sur champs inconnus au niveau racine/defaults/by_type ; write_rules_template() valide version.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions