From 9d923e8e6d3769688a4a2b46e096f63582f25b3e Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 12 May 2020 21:21:28 +0200 Subject: [PATCH] Update syntax of some options so they are better displayed in Docs --- src/mod_admin_extra.erl | 2 +- src/mod_multicast.erl | 16 ++++++++-------- src/mod_pubsub.erl | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/mod_admin_extra.erl b/src/mod_admin_extra.erl index 69d240e4a..503077353 100644 --- a/src/mod_admin_extra.erl +++ b/src/mod_admin_extra.erl @@ -1605,7 +1605,7 @@ mod_doc() -> "administrator changes their password again. It is possible to " "define the reason of the ban. The new password also includes " "the reason and the date and time of the ban. See an example below."), - ?T("- 'pushroster' (and 'pushroster-all'):"), + ?T("- 'pushroster': (and 'pushroster-all')"), ?T("The roster file must be placed, if using Windows, on the " "directory where you installed ejabberd: " "C:/Program Files/ejabberd or similar. If you use other " diff --git a/src/mod_multicast.erl b/src/mod_multicast.erl index d8205e8a9..df6538ee8 100644 --- a/src/mod_multicast.erl +++ b/src/mod_multicast.erl @@ -1188,19 +1188,19 @@ mod_doc() -> desc => [?T("Specify a list of custom limits which override the " "default ones defined in XEP-0033. Limits are defined " - "per sender type and stanza type, where:"), - ?T("- The sender type can be: 'local' or 'remote'."), "", - ?T("- The stanza type can be: 'message' or 'presence'."), "", - ?T("- The number can be a positive integer or the key word 'infinite'.")], + "per sender type and stanza type, where:"), "", + ?T("- 'sender' can be: 'local' or 'remote'."), + ?T("- 'stanza' can be: 'message' or 'presence'."), + ?T("- 'number' can be a positive integer or 'infinite'.")], example => - [{?T("Default values:"), - ["local:", + ["# Default values:", + "local:", " message: 100", " presence: 100", "remote:", " message: 20", - " presence: 20"]} - ]}}, + " presence: 20"] + }}, {name, #{desc => ?T("Service name to provide in the Info query to the " "Service Discovery. Default is '\"Multicast\"'.")}}, diff --git a/src/mod_pubsub.erl b/src/mod_pubsub.erl index c8dd45481..6551945fa 100644 --- a/src/mod_pubsub.erl +++ b/src/mod_pubsub.erl @@ -4303,17 +4303,17 @@ mod_doc() -> #{value => "List of Key:Value", desc => ?T("This allows to define a list of key-value to choose " - "defined node plugins on given PEP namespace."), + "defined node plugins on given PEP namespace. " + "The following example will use 'node_tune' instead of " + "'node_pep' for every PEP node with the tune namespace:"), example => - [{?T("The following example will use 'node_tune' instead of " - "'node_pep' for every PEP node with the tune namespace:"), ["modules:", " ...", " mod_pubsub:", " pep_mapping:", " http://jabber.org/protocol/tune: tune", " ..."] - }]}}, + }}, {plugins, #{value => "[Plugin, ...]", desc => [?T("To specify which pubsub node plugins to use. "