Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/lib/bugdown/help_settings_links.py
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)

2
zerver/tests/test_docs.py
View File

@ -175,7 +175,7 @@ class HelpTest(ZulipTestCase):
def test_html_settings_links_help_docs(self) -> None:
result = self.client_get('/help/change-the-time-format')
self.assertIn('click <a href="/#settings/display-settings">Display settings</a>', str(result.content))
self.assertIn('Go to <a href="/#settings/display-settings">Display settings</a>', str(result.content))
self.assertEqual(result.status_code, 200)
with self.settings(ROOT_DOMAIN_LANDING_PAGE=True):