Skip to content
Snippets Groups Projects
Verified Commit e717eadd authored by Jonathan Weth's avatar Jonathan Weth :keyboard:
Browse files

Add help texts for preferences

parent 1234a879
No related branches found
No related tags found
1 merge request!2Resolve "Review tasks"
Pipeline #57682 failed
...@@ -14,6 +14,10 @@ class Homeserver(StringPreference): ...@@ -14,6 +14,10 @@ class Homeserver(StringPreference):
name = "homeserver" name = "homeserver"
verbose_name = _("URL of Matrix homeserver") verbose_name = _("URL of Matrix homeserver")
default = "" default = ""
help_text = _(
"URL of the Matrix homeserver on which groups and "
"spaces should be created (e. g. https://matrix.org)"
)
@site_preferences_registry.register @site_preferences_registry.register
...@@ -31,6 +35,9 @@ class AccessToken(StringPreference): ...@@ -31,6 +35,9 @@ class AccessToken(StringPreference):
name = "access_token" name = "access_token"
verbose_name = _("Access token to access homeserver") verbose_name = _("Access token to access homeserver")
default = "" default = ""
help_text = _(
"This has to be the access token of a suitable bot user. It is used for all actions."
)
@site_preferences_registry.register @site_preferences_registry.register
...@@ -39,6 +46,7 @@ class DisambiguateRoomAliases(BooleanPreference): ...@@ -39,6 +46,7 @@ class DisambiguateRoomAliases(BooleanPreference):
name = "disambiguate_room_aliases" name = "disambiguate_room_aliases"
verbose_name = _("Disambiguate room aliases") verbose_name = _("Disambiguate room aliases")
default = True default = True
help_text = _("Suffix room aliases with ascending numbers to avoid name clashes")
@site_preferences_registry.register @site_preferences_registry.register
...@@ -47,6 +55,7 @@ class UseSpaces(BooleanPreference): ...@@ -47,6 +55,7 @@ class UseSpaces(BooleanPreference):
name = "use_spaces" name = "use_spaces"
verbose_name = _("Use Matrix spaces") verbose_name = _("Use Matrix spaces")
default = True default = True
help_text = _("This activates the creation and management of Matrix spaces.")
@site_preferences_registry.register @site_preferences_registry.register
...@@ -55,6 +64,7 @@ class ReducePowerLevels(BooleanPreference): ...@@ -55,6 +64,7 @@ class ReducePowerLevels(BooleanPreference):
name = "reduce_power_levels" name = "reduce_power_levels"
verbose_name = _("Reduce existing power levels") verbose_name = _("Reduce existing power levels")
default = False default = False
help_text = _("Reduce power levels of existing members to the level suggested by AlekSIS.")
@site_preferences_registry.register @site_preferences_registry.register
...@@ -64,6 +74,7 @@ class PowerLevelForOwners(IntegerPreference): ...@@ -64,6 +74,7 @@ class PowerLevelForOwners(IntegerPreference):
verbose_name = _("Power level for owners") verbose_name = _("Power level for owners")
default = 50 default = 50
required = True required = True
help_text = _("This power level will be set for all owners of a group.")
@site_preferences_registry.register @site_preferences_registry.register
...@@ -73,3 +84,4 @@ class PowerLevelForMembers(IntegerPreference): ...@@ -73,3 +84,4 @@ class PowerLevelForMembers(IntegerPreference):
verbose_name = _("Power level for members") verbose_name = _("Power level for members")
default = 0 default = 0
required = True required = True
help_text = _("This power level will be set for all members of a group.")
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment