Skip to content

Commit

Permalink
docs: improve godoc (#134)
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
  • Loading branch information
caarlos0 authored Dec 22, 2022
1 parent 8e35697 commit d571a5c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion blocking/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@ import (
//
// On EOF, it'll keep trying to read again every 10ms.
//
// The purpose of this is to be used to "emulate a STDIN" (which never EOFs)
// The purpose of this is to be used to "emulate a STDIN"
// from another io.Reader, for example, a bytes.Buffer.
//
// We need that because when we connect into an app through wishlist, we need
// to keep a copy of STDIN (named handoffstdin in most places). That copy is a
// bytes.Buffer, which would EOF on last byte, but we are still writing to
// it... so it shouldn't really EOF. Hence, this Reader. It'll never EOF, and
// will keep trying to read until another error happens.
type Reader struct {
r io.Reader
}
Expand Down

0 comments on commit d571a5c

Please sign in to comment.