summaryrefslogtreecommitdiff
path: root/config/description.exs
diff options
context:
space:
mode:
authorminibikini <egor@kislitsyn.com>2020-10-30 11:18:55 +0000
committerminibikini <egor@kislitsyn.com>2020-10-30 11:18:55 +0000
commit1cc8e945064319014300de5880a326d1100bf43e (patch)
tree938600cf0605372a15fe0cd909f94c364e409c20 /config/description.exs
parent8542d2efee86131350736a9be96713551e01f6ed (diff)
parent131f3219e6b895139c5647cd2050dd22adce7139 (diff)
downloadpleroma-1cc8e945064319014300de5880a326d1100bf43e.tar.gz
pleroma-1cc8e945064319014300de5880a326d1100bf43e.zip
Merge branch 'develop' into 'feature/local-only-scope'
# Conflicts: # CHANGELOG.md
Diffstat (limited to 'config/description.exs')
-rw-r--r--config/description.exs25
1 files changed, 17 insertions, 8 deletions
diff --git a/config/description.exs b/config/description.exs
index 0bfa9979f..798cbe2ad 100644
--- a/config/description.exs
+++ b/config/description.exs
@@ -1757,28 +1757,37 @@ config :pleroma, :config_description, [
related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
label: "MRF Keyword",
type: :group,
- description: "Reject or Word-Replace messages with a keyword or regex",
+ description:
+ "Reject or Word-Replace messages matching a keyword or [Regex](https://hexdocs.pm/elixir/Regex.html).",
children: [
%{
key: :reject,
type: {:list, :string},
- description:
- "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
+ description: """
+ A list of patterns which result in message being rejected.
+
+ Each pattern can be a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
+ """,
suggestions: ["foo", ~r/foo/iu]
},
%{
key: :federated_timeline_removal,
type: {:list, :string},
- description:
- "A list of patterns which result in message being removed from federated timelines (a.k.a unlisted). Each pattern can be a string or a regular expression.",
+ description: """
+ A list of patterns which result in message being removed from federated timelines (a.k.a unlisted).
+
+ Each pattern can be a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
+ """,
suggestions: ["foo", ~r/foo/iu]
},
%{
key: :replace,
type: {:list, :tuple},
- description:
- "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
- suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
+ description: """
+ **Pattern**: a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
+
+ **Replacement**: a string. Leaving the field empty is permitted.
+ """
}
]
},