Skip to content

Define each solver keyword default in one place - #108

Merged
timholy merged 1 commit into
mainfrom
teh/kwarg-defaults
Oct 28, 2026
Merged

timholy merged 1 commit into
mainfrom
teh/kwarg-defaults

Conversation

@timholy

@timholy timholy commented Oct 28, 2026

Copy link
Copy Markdown
Member

The public solver functions forward their keywords to one options function per solver family, which holds the defaults: _powermean_options for the PowerMean soft covers and noise_cover, _auglag_options (with _auglag_linsolve_options) for the minimal covers, cover_transversal, and the AbsLog{2} soft covers, and _balanced_options for cover_transversal(::PowerMean, A). A keyword outside a function's documented set, including the internal keywords of the workers, throws a MethodError before any work is done.

Docstrings interpolate the constants behind their stated defaults, so the documented values follow the code. soft_covers.jl is included after minimal_covers.jl so that those constants are defined first.

Assisted-by: Claude Opus 5.5 noreply@anthropic.com

The public solver functions forward their keywords to one options
function per solver family, which holds the defaults:
`_powermean_options` for the PowerMean soft covers and `noise_cover`,
`_auglag_options` (with `_auglag_linsolve_options`) for the minimal
covers, `cover_transversal`, and the AbsLog{2} soft covers, and
`_balanced_options` for `cover_transversal(::PowerMean, A)`. A keyword
outside a function's documented set, including the internal keywords of
the workers, throws a MethodError before any work is done.

Docstrings interpolate the constants behind their stated defaults, so
the documented values follow the code. `soft_covers.jl` is included
after `minimal_covers.jl` so that those constants are defined first.

Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.33%. Comparing base (0b8d00b) to head (12c2cee).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #108   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          26       26           
  Lines        8222     8230    +8     
=======================================
+ Hits         8085     8093    +8     
  Misses        137      137           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timholy
timholy merged commit 912b442 into main Oct 28, 2026
7 checks passed
@timholy
timholy deleted the teh/kwarg-defaults branch October 28, 2026 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant