From 6f4e7dc118330b0ce9ca5e930217311b38522c55 Mon Sep 17 00:00:00 2001
From: ieQu1 <99872536+ieQu1@users.noreply.github.com>
Date: Tue, 22 Mar 2022 20:19:08 +0100
Subject: [PATCH] docs(schema): Formatting
---
apps/emqx_conf/src/emqx_conf_schema.erl | 4 +++-
apps/emqx_modules/src/emqx_modules_schema.erl | 19 ++++++++++---------
2 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/apps/emqx_conf/src/emqx_conf_schema.erl b/apps/emqx_conf/src/emqx_conf_schema.erl
index b0d467e34..7fb9d730a 100644
--- a/apps/emqx_conf/src/emqx_conf_schema.erl
+++ b/apps/emqx_conf/src/emqx_conf_schema.erl
@@ -626,7 +626,9 @@ fields("log") ->
, {"error_logger",
sc(atom(),
#{mapping => "kernel.error_logger",
- default => silent})}
+ default => silent,
+ desc => "Deprecated."
+ })}
];
fields("console_handler") ->
diff --git a/apps/emqx_modules/src/emqx_modules_schema.erl b/apps/emqx_modules/src/emqx_modules_schema.erl
index 90dc85088..8400311d5 100644
--- a/apps/emqx_modules/src/emqx_modules_schema.erl
+++ b/apps/emqx_modules/src/emqx_modules_schema.erl
@@ -123,15 +123,16 @@ fields("event_message") ->
}
)}
],
- #{fields => Fields,
- desc => """
-Enable/Disable system event messages.
-The messages are published to $event
prefixed topics.
-For example, if `client_disconnected` is set to `true`,
-a message is published to $event/client_connected
topic
-whenever a client is connected.
-"""};
-
+ #{
+ fields => Fields,
+ desc =>
+ "Enable/Disable system event messages.\n"
+ "The messages are published to $event
prefixed topics.\n"
+ "For example, if `client_disconnected` is set to `true`,\n"
+ "a message is published to $event/client_connected
topic\n"
+ "whenever a client is connected.\n"
+ ""
+ };
fields("topic_metrics") ->
[{topic, sc(binary(), #{})}].