From 532f5479b3685de732d9cf94617242933f8d19b4 Mon Sep 17 00:00:00 2001
From: Fabio Manganiello <fabio@manganiello.tech>
Date: Sat, 30 Sep 2023 14:34:54 +0200
Subject: [PATCH] Added full YAML example for `chat.irc` configuration.

---
 platypush/plugins/chat/irc/__init__.py | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/platypush/plugins/chat/irc/__init__.py b/platypush/plugins/chat/irc/__init__.py
index e5e11ec7..ef862398 100644
--- a/platypush/plugins/chat/irc/__init__.py
+++ b/platypush/plugins/chat/irc/__init__.py
@@ -22,7 +22,27 @@ class ChatIrcPlugin(RunnablePlugin, ChatPlugin):
 
     def __init__(self, servers: Sequence[dict], **kwargs):
         """
-        :param servers: List of servers/channels that the bot will automatically connect/join.
+        :param servers: List of servers/channels that the bot will
+            automatically connect/join. Format:
+
+              .. code-block:: yaml
+
+                servers:
+                  - server: irc.example.org
+                    port: 6697
+                    ssl: true
+                    ipv6: false
+                    username: foo
+                    password: bar
+                    nickname: testbot
+                    realname: Test Bot
+
+                    # List of channels that the bot will automatically join
+                    channels:
+                      - #channel1
+                      - #channel2
+                      - #channel3
+
         """
         super().__init__(**kwargs)
         try: