From d3c6ade64059743d7806f816a594b37b7fab4d74 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Thu, 3 Nov 2022 16:18:45 -0300 Subject: [PATCH] docs: rewrite fn doc --- apps/emqx_rule_engine/src/emqx_rule_engine_jwt_sup.erl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/emqx_rule_engine/src/emqx_rule_engine_jwt_sup.erl b/apps/emqx_rule_engine/src/emqx_rule_engine_jwt_sup.erl index 4f3e24cce..b393dd08b 100644 --- a/apps/emqx_rule_engine/src/emqx_rule_engine_jwt_sup.erl +++ b/apps/emqx_rule_engine/src/emqx_rule_engine_jwt_sup.erl @@ -42,9 +42,9 @@ init([]) -> ChildSpecs = [], {ok, {SupFlags, ChildSpecs}}. -%% @doc Starts a new JWT worker. The worker will send the caller a -%% message when it creates and stores its first JWT, or if it fails to -%% do so, using a generated reference. +%% @doc Starts a new JWT worker. The caller should use +%% `emqx_rule_engine_jwt_sup:ensure_jwt/1' to ensure that a JWT has +%% been stored, if synchronization is needed. -spec ensure_worker_present(worker_id(), map()) -> {ok, supervisor:child()}. ensure_worker_present(Id, Config) ->