From 78c64d069b7b8e9483a07d11dc4c864b5738c065 Mon Sep 17 00:00:00 2001 From: "neiljp (Neil Pilgrim)" Date: Fri, 1 Jun 2018 18:05:54 -0700 Subject: [PATCH] matrix bridge: Add description of script & some useful tips. --- zulip/integrations/matrix/matrix_bridge.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/zulip/integrations/matrix/matrix_bridge.py b/zulip/integrations/matrix/matrix_bridge.py index 2b95b3e..2eb5252 100644 --- a/zulip/integrations/matrix/matrix_bridge.py +++ b/zulip/integrations/matrix/matrix_bridge.py @@ -157,7 +157,19 @@ def check_zulip_message_validity(msg: Dict[str, Any], config: Dict[str, Any]) -> def parse_args(): # type: () -> Any - parser = argparse.ArgumentParser() + description = """ + Script to bridge between a topic in a Zulip stream, and a Matrix channel. + + Tested connections: + * Zulip <-> Matrix channel + * Zulip <-> IRC channel (bridged via Matrix) + + Example matrix 'room_id' options might be, if via matrix.org: + * #zulip:matrix.org (zulip channel on Matrix) + * #freenode_#zulip:matrix.org (zulip channel on irc.freenode.net)""" + + parser = argparse.ArgumentParser(description=description, + formatter_class=argparse.RawTextHelpFormatter) parser.add_argument('-c', '--config', required=True, help="Path to the config file for the bridge.") parser.add_argument('--show-join-leave', dest='no_noise',