Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up return types #310

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Clean up return types #310

merged 1 commit into from
Dec 16, 2024

Conversation

dumbbell
Copy link
Member

@dumbbell dumbbell commented Dec 12, 2024

Why

khepri_machine:common_ret() and khepri_adv:many_results() were synonyms. With the removal of khepri_adv:single_result(), the distinction becomes irrelevant: we don't need
khepri_adv:many_results() is now useless.

Also, the name khepri_machine:common_ret() didn't mean much because it is only used by few functions.

How

khepri_machine:common_ret() is renamed to khepri_machine:write_ret() and the khepri_adv:many_results() alias is removed.

While here, move khepri_adv:node_props_map() to khepri.

@dumbbell dumbbell added the enhancement New feature or request label Dec 12, 2024
@dumbbell dumbbell added this to the v0.17.0 milestone Dec 12, 2024
@dumbbell dumbbell self-assigned this Dec 12, 2024
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.73%. Comparing base (1c29b1d) to head (2fb4110).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #310   +/-   ##
=======================================
  Coverage   89.73%   89.73%           
=======================================
  Files          22       22           
  Lines        3263     3263           
=======================================
  Hits         2928     2928           
  Misses        335      335           
Flag Coverage Δ
erlang-25 88.96% <ø> (+0.39%) ⬆️
erlang-26 89.33% <ø> (+0.09%) ⬆️
erlang-27 89.36% <ø> (-0.31%) ⬇️
os-ubuntu-latest 89.67% <ø> (-0.04%) ⬇️
os-windows-latest 89.45% <ø> (-0.04%) ⬇️

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.

@dumbbell dumbbell marked this pull request as ready for review December 12, 2024 15:41
@dumbbell dumbbell force-pushed the cleanup-return-types branch from c973942 to 10ad873 Compare December 12, 2024 16:30
[Why]
`khepri_machine:common_ret()` and `khepri_adv:many_results()` were
synonyms. With the removal of `khepri_adv:single_result()`, the
distinction becomes irrelevant: we don't need
`khepri_adv:many_results()` is now useless.

Also, the name `khepri_machine:common_ret()` didn't mean much because it
is only used by few functions.

[How]
`khepri_machine:common_ret()` is renamed to `khepri_machine:write_ret()`
and the `khepri_adv:many_results()` alias is removed.

While here, move `khepri_adv:node_props_map()` to `khepri`.
@dumbbell dumbbell force-pushed the cleanup-return-types branch from 10ad873 to 2fb4110 Compare December 16, 2024 10:33
@dumbbell dumbbell merged commit 0db160f into main Dec 16, 2024
26 checks passed
@dumbbell dumbbell deleted the cleanup-return-types branch December 16, 2024 10:45
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.

2 participants