From bb234c8348d5c14c6484de66f11e0b79ddbfc1eb Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Mon, 8 Jul 2024 23:16:14 +0200
Subject: [PATCH] conn: document conn.ReadMessage

---
 conn.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/conn.go b/conn.go
index 7e07a47..5f17585 100644
--- a/conn.go
+++ b/conn.go
@@ -194,6 +194,10 @@ func (c *conn) Close() error {
 	return err
 }
 
+// Read reads an incoming message. It must be called from a single goroutine
+// at a time.
+//
+// io.EOF is returned when there are no more messages to read.
 func (c *conn) ReadMessage() (*irc.Message, error) {
 	msg, err := c.conn.ReadMessage()
 	if errors.Is(err, net.ErrClosed) {