docs: RFC surface d'API 0.5 (design a discuter, rien d'implemente)#54
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an RFC document to propose/discuss an API surface redesign planned for datadiff 0.5, aligned with the UX/design topics tracked in issue #33 (no implementation changes).
Changes:
- Add
dev/RFC-api-0.5.mddescribing proposed 0.5 API surface (naming, options objects, result class, thresholds, language defaults). - Document a deprecation plan and link/recap related issues/quick wins.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+40
to
+41
| lang = getOption("datadiff.lang", "fr"), | ||
| locale = getOption("datadiff.locale", "fr_FR") |
Comment on lines
+1
to
+5
| # RFC : surface d'API datadiff 0.5 | ||
|
|
||
| Statut : proposition a discuter (issue #33). Rien ici n'est implemente ; | ||
| les quick wins non cassants identifies sont listes en fin de document avec | ||
| leur issue de rattachement. |
Member
Author
There was a problem hiding this comment.
Valides tous les deux, appliques : ^dev$ embarque dans CETTE PR (l'attendre de la PR menage etait un ordre de merge fragile), et l'exemple annote comme defauts actuels 0.4.x vs proposition section 5.
Document de design a discuter, sans implementation : nom compare_datasets() + alias retrocompatible, objets d'options extract_opts()/engine_opts(), retour de classe datadiff_result (passed/report, depreciation de reponse/all_passed dupliques), fail_at unique, bascule lang en a la 0.5, cycle de depreciation en 3 versions. Les quick wins non cassants sont rattaches aux issues deja traitees (#16/#20/#25/#26/#27/#30).
VincentGuyader
force-pushed
the
docs/issue-33-rfc-api-0.5
branch
from
July 3, 2026 10:28
c902be4 to
477f840
Compare
This was referenced Jul 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribue a #33 (a fermer apres discussion et decision, pas par ce merge)
Contenu
dev/RFC-api-0.5.md: proposition de refonte de surface pour la 0.5, a discuter :compare_datasets()+ alias retrocompatiblecompare_datasets_from_yaml()(cycle de depreciation en 3 versions)extract_opts()/engine_opts()pour degonfler les 15+ parametresdatadiff_result:passed/report, depreciation des doublonsreponse/all_passedfail_atunique (warn_at/stop_at fusionnes)lang = "en"par defaut a la 0.5 (annoncee, pas subie)Les quick wins non cassants identifies par l'issue sont deja livres par les PRs #35 (#16), #37 (#20), #44 (#30), #51 (#27), #52 (#25), #53 (#26).
Le fichier est hors tarball (
.Rbuildignore^dev$arrive par la PR #34). Un commentaire de synthese sera poste sur l'issue #33 apres merge pour lancer la discussion.