Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[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
  • Is something wrong?
#32 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
r
Domain
documentation

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.

Description

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 #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 #26).
  5. Vignette §extraits (post PR #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.
Dominant language
R
Stars
6
Forks
0
Avg merge
1d 12h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ThinkR-open/datadiff

All issues in ThinkR-open/datadiff

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.