From 7b3e46a7c22beaa917831e5a8f535e39be2364b4 Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Thu, 3 Mar 2022 10:53:33 +0100
Subject: [PATCH] downstream: re-format illegalNickChars doc comment

---
 downstream.go | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/downstream.go b/downstream.go
index c4d39f6..4c08fd1 100644
--- a/downstream.go
+++ b/downstream.go
@@ -207,9 +207,14 @@ func updateNetworkAttrs(record *Network, attrs irc.Tags, subcommand string) erro
 	return nil
 }
 
-// ' ' and ':' break the IRC message wire format, '@' and '!' break prefixes,
-// '*' and '?' break masks, '$' breaks server masks in PRIVMSG/NOTICE,
-// "*" is the reserved nickname for registration, ',' breaks lists
+// illegalNickChars is the list of characters forbidden in a nickname.
+//
+//     ' ' and ':' break the IRC message wire format
+//     '@' and '!' break prefixes
+//     '*' breaks masks and is the reserved nickname for registration
+//     '?' breaks masks
+//     '$' breaks server masks in PRIVMSG/NOTICE
+//     ',' breaks lists
 const illegalNickChars = " :@!*?$,"
 
 // permanentDownstreamCaps is the list of always-supported downstream