chore(docs): IRC channels should be given without the first # (#65)

OpenTTD · Sep 16, 2022 · 10d4ff7 · 10d4ff7
1 parent d05305e
commit 10d4ff7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -54,13 +54,15 @@ Usage: python -m dibridge [OPTIONS]
 Options:
   --sentry-dsn TEXT             Sentry DSN.
   --sentry-environment TEXT     Environment we are running in.
-  --discord-token TEXT          Discord bot token to authenticate  [required]
-  --discord-channel-id INTEGER  Discord channel ID to relay to  [required]
-  --irc-host TEXT               IRC host to connect to  [required]
-  --irc-port INTEGER            IRC SSL port to connect to
-  --irc-nick TEXT               IRC nick to use  [required]
-  --irc-channel TEXT            IRC channel to relay to  [required]
-  --irc-puppet-ip-range TEXT    An IPv6 CIDR range to use for IRC puppets
+  --discord-token TEXT          Discord bot token to authenticate.  [required]
+  --discord-channel-id INTEGER  Discord channel ID to relay to.  [required]
+  --irc-host TEXT               IRC host to connect to.  [required]
+  --irc-port INTEGER            IRC SSL port to connect to.
+  --irc-nick TEXT               IRC nick to use.  [required]
+  --irc-channel TEXT            IRC channel to relay to, without the first
+                                '#'.  [required]
+  --irc-puppet-ip-range TEXT    An IPv6 CIDR range to use for IRC puppets.
+                                (2001:A:B:C:D::/80)
   -h, --help                    Show this message and exit.
 ```
 

diff --git a/dibridge/__main__.py b/dibridge/__main__.py
@@ -21,7 +21,7 @@
 @click.option("--irc-host", help="IRC host to connect to.", required=True)
 @click.option("--irc-port", help="IRC SSL port to connect to.", default=6697, type=int)
 @click.option("--irc-nick", help="IRC nick to use.", required=True)
-@click.option("--irc-channel", help="IRC channel to relay to.", required=True)
+@click.option("--irc-channel", help="IRC channel to relay to, without the first '#'.", required=True)
 @click.option("--irc-puppet-ip-range", help="An IPv6 CIDR range to use for IRC puppets. (2001:A:B:C:D::/80)")
 def main(discord_token, discord_channel_id, irc_host, irc_port, irc_nick, irc_channel, irc_puppet_ip_range):
     if irc_puppet_ip_range: