Merge pull request #6430 from zmstone/docs-fix-markdown

docs: change <module> to {module} so markdown render will not crash
This commit is contained in:
Zaiming (Stone) Shi 2021-12-13 08:17:21 +01:00 committed by GitHub
commit 75aa2683ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions

View File

@ -118,7 +118,8 @@ fields("user_provided_function") ->
[ {function, sc(binary(), [ {function, sc(binary(),
#{ desc => """ #{ desc => """
The user provided function. Should be in the format: '{module}:{function}'.<br> The user provided function. Should be in the format: '{module}:{function}'.<br>
Where the <module> is the erlang callback module and the {function} is the erlang function.<br> Where {module} is the Erlang callback module and {function} is the Erlang function.
<br>
To write your own function, checkout the function <code>console</code> and To write your own function, checkout the function <code>console</code> and
<code>republish</code> in the source file: <code>republish</code> in the source file:
<code>apps/emqx_rule_engine/src/emqx_rule_outputs.erl</code> as an example. <code>apps/emqx_rule_engine/src/emqx_rule_outputs.erl</code> as an example.