From a1c3c03b520a3b50c25ebfc4a341c020537894bb Mon Sep 17 00:00:00 2001
From: slashformotion <slashformotion@protonmail.com>
Date: Tue, 7 Oct 2025 18:45:32 +0200
Subject: [PATCH] chore: change the comment on NewReader to make it explicit
 the function can panic

---
 reader.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/reader.go b/reader.go
index 04d90f355..a9ae3c867 100644
--- a/reader.go
+++ b/reader.go
@@ -626,6 +626,9 @@ type readerStats struct {
 
 // NewReader creates and returns a new Reader configured with config.
 // The offset is initialized to FirstOffset.
+//
+// This function will panic if the [ReaderConfig] argument is invalid.
+// Consider calling [ReaderConfig.Validate] before to make sure your config is valid.
 func NewReader(config ReaderConfig) *Reader {
 	if err := config.Validate(); err != nil {
 		panic(err)