Skip to content

Several fixes and additions to the docs#321

Merged
dumbbell merged 3 commits into
mainfrom
docs-fixes
Mar 27, 2025
Merged

Several fixes and additions to the docs#321
dumbbell merged 3 commits into
mainfrom
docs-fixes

Conversation

@dumbbell
Copy link
Copy Markdown
Collaborator

  • khepri: Mention functions that must be updated when a new option is added
  • khepri_machine: Fix documentation of process_query/3
  • khepri_machine: Fix EDoc syntax

…dded

[Why]
This was not documented before. Forgetting to update these functions
will cause bugs and Dialyzer warnings.
[Why]
It has not beep updated after the queries were all processed by the
local Ra member instead of the leader.

Also, the first sentence was missing a word.
@dumbbell dumbbell added the documentation Improvements or additions to documentation label Mar 27, 2025
@dumbbell dumbbell added this to the v0.17.0 milestone Mar 27, 2025
@dumbbell dumbbell self-assigned this Mar 27, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.30%. Comparing base (b5a54e5) to head (90f0cb2).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #321      +/-   ##
==========================================
+ Coverage   89.09%   89.30%   +0.21%     
==========================================
  Files          22       22              
  Lines        3301     3301              
==========================================
+ Hits         2941     2948       +7     
+ Misses        360      353       -7     
Flag Coverage Δ
erlang-26 89.24% <ø> (+0.18%) ⬆️
erlang-27 89.09% <ø> (+0.15%) ⬆️
os-ubuntu-latest 89.09% <ø> (+0.12%) ⬆️
os-windows-latest 89.30% <ø> (+0.21%) ⬆️

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 27, 2025 10:48
@dumbbell dumbbell merged commit 070faa4 into main Mar 27, 2025
@dumbbell dumbbell deleted the docs-fixes branch March 27, 2025 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant