Skip to content

chore: change the comment on NewReader to make it explicit the function can panic #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −0
Open

chore: change the comment on NewReader to make it explicit the function can panic #1407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions reader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down