Skip to content

Commit

Permalink
khepri_machine: Remove @private tag for make_virgin_state/1
Browse files Browse the repository at this point in the history
[Why]
Apparently EDoc doesn't like this directive for code behind a
`-ifdef(TEST).` macro. It fails with the following error:

    .../src/khepri_machine.erl, in module footer: at line 1994: tag @Private not allowed here.
    edoc: skipping source file '.../src/khepri_machine.erl': {'EXIT',error}.

[How]
Just delete the tag for now. The function is not exported anyway when
the doc is built.
  • Loading branch information
dumbbell committed Mar 28, 2024
1 parent 2ee52e6 commit 076926a
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion src/khepri_machine.erl
Original file line number Diff line number Diff line change
Expand Up @@ -1991,7 +1991,6 @@ set_metrics(#khepri_machine{} = State, Metrics) ->
-spec make_virgin_state(Config) -> State when
Config :: khepri_machine:machine_config(),
State :: khepri_machine:state().
%% @private

make_virgin_state(Config) ->
#khepri_machine{config = Config}.
Expand Down

0 comments on commit 076926a

Please sign in to comment.