refactor: move optional arguments of hrg-embedding functions behind the ellipsis - #2771
Merged
Conversation
krlmlr
force-pushed
the
claude/ellipsis-hrg-embedding
branch
2 times, most recently
from
July 26, 2026 11:09
60af603 to
fb2efa0
Compare
Contributor
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if fb2efa0 is merged into main:
|
krlmlr
marked this pull request as ready for review
July 26, 2026 15:03
krlmlr
force-pushed
the
claude/ellipsis-hrg-embedding
branch
2 times, most recently
from
July 26, 2026 15:20
82f8f7e to
e4cbbc2
Compare
Contributor
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if e4cbbc2 is merged into main:
|
krlmlr
force-pushed
the
claude/ellipsis-hrg-embedding
branch
from
July 26, 2026 16:24
e4cbbc2 to
0f7d122
Compare
…he ellipsis Insert `...` between the defining arguments and the optional modifiers of 7 functions, following the zoning rules in CONTRIBUTING.md. Legacy positional and abbreviated calls are recovered by the generated ARG_HANDLE blocks (registry: tools/migrations/hrg-embedding.R) and emit a single soft deprecation for igraph 3.0.0. No defaults change and no arguments are renamed. Functions: consensus_tree, embed_adjacency_matrix, embed_laplacian_matrix, fit_hrg, predict_edges, sample_sphere_surface, sample_sphere_volume Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016M32izVHZPfxAqemAe4BrX
Add an "ellipsis migration: argument coverage" section to test-hrg.R and test-embedding.R exercising the keyword-only tail arguments and the legacy positional recovery path (with its deprecation warning) for the seven migrated functions: fit_hrg(), consensus_tree(), predict_edges(), embed_adjacency_matrix(), embed_laplacian_matrix(), sample_sphere_surface(), and sample_sphere_volume(). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016M32izVHZPfxAqemAe4BrX
Contributor
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if 2585709 is merged into main:
|
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.
Part of the repo-wide ellipsis migration coordinated in #2757 —
see that PR for the full rationale (CONTRIBUTING.md, Argument Order and the Ellipsis).
Based directly on
main(the registry split landed via #2779); a single topic commit.What this does
Inserts
...between the defining arguments (head) and the optionalmodifiers (tail) of 7 exported hrg-embedding functions.
Arguments after
...become keyword-only.ARG_HANDLE block and emit a single
lifecycle::deprecate_soft("3.0.0", …)—behavior is unchanged.
tools/migrations/hrg-embedding.R; blocks regenerated viaRscript tools/generate-migrations.R(idempotent, CI-checked).New signatures
embed_adjacency_matrix()graph, noweights, which, scaled, cvec, optionsembed_laplacian_matrix()graph, noweights, which, type, scaled, optionssample_sphere_surface()dim, nradius, positivesample_sphere_volume()dim, nradius, positiveconsensus_tree()graph, hrgstart, num.samplesfit_hrg()graph, hrgstart, stepspredict_edges()graph, hrgstart, num.samples, num.binsNotes for review
igraph.r2cdocs(GitHub API unreachable), so
man/*.Rdfiles were updated mechanically(usage +
...argument item) instead of viadevtools::document().R CMD check's usage↔formals validation passes; a follow-up
devtools::document()run may reflow whitespace but should produce nosemantic diff.
named arguments (they are the same soft-deprecation user code will see).