user docs: Shorten instructions when using relative settings links.

This commit is contained in:
Rishi Gupta
2018-08-20 21:11:00 -07:00
parent 36d495736a
commit 99b55b712b
2 changed files with 4 additions and 8 deletions

View File

@@ -97,13 +97,9 @@ class Setting(Preprocessor):
setting_name = link_mapping[setting_identifier][1]
setting_link = link_mapping[setting_identifier][2]
if relative_settings_links:
setting_reference = "[%s](%s)" % (setting_name, setting_link)
else:
setting_reference = "**%s**" % (setting_name,)
instructions = settings_markdown % {'setting_type_name': setting_type_name,
'setting_reference': setting_reference}
return instructions
return "1. Go to [%s](%s)." % (setting_name, setting_link)
return settings_markdown % {'setting_type_name': setting_type_name,
'setting_reference': "**%s**" % (setting_name,)}
def makeExtension(*args: Any, **kwargs: Any) -> SettingHelpExtension:
return SettingHelpExtension(*args, **kwargs)