diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl index 8a91f2c06..5513443f9 100644 --- a/apps/emqx/src/emqx_schema.erl +++ b/apps/emqx/src/emqx_schema.erl @@ -1377,7 +1377,7 @@ fields("sysmon_vm") -> desc => "The threshold, as percentage of processes, for how many\n" " processes can simultaneously exist at the local node before the corresponding\n" - " alarm is set." + " alarm is raised." } )}, {"process_low_watermark", @@ -1451,7 +1451,7 @@ fields("sysmon_os") -> default => "80%", desc => "The threshold, as percentage of system CPU load,\n" - " for how much system cpu can be used before the corresponding alarm is set." + " for how much system cpu can be used before the corresponding alarm is raised." } )}, {"cpu_low_watermark", @@ -1479,7 +1479,7 @@ fields("sysmon_os") -> default => "70%", desc => "The threshold, as percentage of system memory,\n" - " for how much system memory can be allocated before the corresponding alarm is set." + " for how much system memory can be allocated before the corresponding alarm is raised." } )}, {"procmem_high_watermark", @@ -1490,7 +1490,7 @@ fields("sysmon_os") -> desc => "The threshold, as percentage of system memory,\n" " for how much system memory can be allocated by one Erlang process before\n" - " the corresponding alarm is set." + " the corresponding alarm is raised." } )} ]; diff --git a/apps/emqx_conf/src/emqx_conf_schema.erl b/apps/emqx_conf/src/emqx_conf_schema.erl index 3849e296b..fe06a8ce3 100644 --- a/apps/emqx_conf/src/emqx_conf_schema.erl +++ b/apps/emqx_conf/src/emqx_conf_schema.erl @@ -421,7 +421,7 @@ fields("db") -> , 'readOnly' => true , desc => """ Select the backend for the embedded database.
-rlog is the default backend, a new experimental backend +rlog is the default backend, that is suitable for very large clusters.
mnesia is a backend that offers decent performance in small clusters. """ diff --git a/apps/emqx_connector/include/emqx_connector.hrl b/apps/emqx_connector/include/emqx_connector.hrl index f97a0110f..0aa61ed35 100644 --- a/apps/emqx_connector/include/emqx_connector.hrl +++ b/apps/emqx_connector/include/emqx_connector.hrl @@ -24,12 +24,13 @@ -define(REDIS_DEFAULT_PORT, 6379). -define(PGSQL_DEFAULT_PORT, 5432). --define(SERVERS_DESC, "A Node list for Cluster to connect to. The nodes should be split with ',', such as: 'Node[,Node]'
\nFor each Node should be:
"). +-define(SERVERS_DESC, "A Node list for Cluster to connect to. The nodes should be separated with commas, such as: `Node[,Node].
` +For each Node should be: "). --define(SERVER_DESC(TYPE, DEFAULT_PORT), """ -The IPv4 or IPv6 address or host name to connect to.
-A host entry has the following form: 'Host[:Port]'
-The """ ++ TYPE ++ " default port " ++ DEFAULT_PORT ++ " is used if '[:Port]' isn't present" +-define(SERVER_DESC(TYPE, DEFAULT_PORT), " +The IPv4 or IPv6 address or the hostname to connect to.
+A host entry has the following form: `Host[:Port]`.
+The " ++ TYPE ++ " default port " ++ DEFAULT_PORT ++ " is used if `[:Port]` is not specified." ). -define(THROW_ERROR(Str), erlang:throw({error, Str})). diff --git a/apps/emqx_rule_engine/src/emqx_rule_engine_schema.erl b/apps/emqx_rule_engine/src/emqx_rule_engine_schema.erl index 288eea233..e8cc786ab 100644 --- a/apps/emqx_rule_engine/src/emqx_rule_engine_schema.erl +++ b/apps/emqx_rule_engine/src/emqx_rule_engine_schema.erl @@ -169,7 +169,7 @@ desc("user_provided_function") -> "Configuration for a built-in output."; desc("republish_args") -> "The arguments of the built-in 'republish' output.
" - "We can use variables in the args.
\n" + "One can use variables in the args.
\n" "The variables are selected by the rule. For example, if the rule SQL is defined as following:\n" "\n" " SELECT clientid, qos, payload FROM \"t/1\"\n" @@ -183,9 +183,9 @@ desc("republish_args") -> " payload = \"msg: ${payload}\"\n" " }\n" "\n" - "When the rule is triggered by an MQTT message with payload = \"hello\", qos = 1,\n" - "clientid = \"Steve\", the rule will republish a new MQTT message to topic \"t/Steve\",\n" - "payload = \"msg: hello\", and qos = 1."; + "When the rule is triggered by an MQTT message with payload = `hello`, qos = 1,\n" + "clientid = `Steve`, the rule will republish a new MQTT message to topic `t/Steve`,\n" + "payload = `msg: hello`, and `qos = 1`."; desc(_) -> undefined.