ThinkR-open / ThinkR-open/datadiff
[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
Open
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 6
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Contexte
Écarts factuels relevés entre la documentation et le code actuel :
@returndecompare_datasets_from_yaml: liste 7 éléments et ometall_passed— le premier élément réellement retourné. Décrit aussiagentcomme « with validation results » alors qu'il n'est pas interrogé (c'estreponsequi l'est).- 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.
- README Quick Start (l.49) : appel sans
key =qui ne fonctionne que via le partial matching$keys→$key(cf. issue #20) ; la vignette passe toujourskeyexplicitement. 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. - Vignette §14 : « By default, pointblank reports are rendered in English » — faux, le défaut est
lang = "fr"(cf. issue #26). - Vignette §extraits (post PR #12) : documente
__absdiff/__threshdans les extraits sans préciser la restriction chemin local uniquement que NEWS mentionne (le lazy n'a jamais ces diagnostics). 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 outreversion = 2queread_rules()refusera.
Critères de succès
-
@returnexhaustif et exact (8 éléments, description d'agentcorrigé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 ;
keyexplicite 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()valideversion.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README, the vignette, the @return documentation in man/, and the read_rules() and write_rules_template() entry points. Compare each documented behavior with the current R code and NEWS, then update the listed docs and validation behavior. Done means all six discrepancies and every success criterion are addressed, with regenerated man/ documentation and current README coverage details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100