Skip to content

khepri_machine: Improve type specs around machine version and API behaviour#368

Merged
dumbbell merged 3 commits into
v0.17.xfrom
improve-type-specs-around-machine-version-and-api-behaviour
Mar 11, 2026
Merged

khepri_machine: Improve type specs around machine version and API behaviour#368
dumbbell merged 3 commits into
v0.17.xfrom
improve-type-specs-around-machine-version-and-api-behaviour

Conversation

@dumbbell
Copy link
Copy Markdown
Collaborator

A collection of improvements. See individual commits for more details.

[Why]
This one is simple to document as it controls the only error it can
return.
[Why]
Be more strict about the `MacVer` argument. This matches the documented
type spec.
[Why]
It does not help Dialyzer because the type includes any `atom()` and we
don't document each individual behaviour here (they are somewhat
documented in the machine versions table at the beginning of the
module).
@dumbbell dumbbell added this to the v0.17.6 milestone Mar 11, 2026
@dumbbell dumbbell self-assigned this Mar 11, 2026
@dumbbell dumbbell added the enhancement New feature or request label Mar 11, 2026
@dumbbell dumbbell changed the base branch from main to v0.17.x March 11, 2026 23:36
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.26%. Comparing base (d40a78f) to head (c65142e).
⚠️ Report is 4 commits behind head on v0.17.x.

Additional details and impacted files
@@             Coverage Diff             @@
##           v0.17.x     #368      +/-   ##
===========================================
+ Coverage    90.17%   90.26%   +0.08%     
===========================================
  Files           22       22              
  Lines         3523     3523              
===========================================
+ Hits          3177     3180       +3     
+ Misses         346      343       -3     
Flag Coverage Δ
erlang-26 90.15% <ø> (ø)
erlang-27 90.23% <ø> (+0.17%) ⬆️
erlang-28 90.15% <ø> (+0.08%) ⬆️
os-ubuntu-latest 90.09% <ø> (+0.08%) ⬆️
os-windows-latest 90.17% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

@dumbbell dumbbell marked this pull request as ready for review March 11, 2026 23:50
@dumbbell dumbbell merged commit 863dde0 into v0.17.x Mar 11, 2026
26 checks passed
@dumbbell dumbbell deleted the improve-type-specs-around-machine-version-and-api-behaviour branch March 11, 2026 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant