authorgravatar for petr.pucil@seznam.czPetr Pučil <petr.pucil@seznam.cz> 2025-11-06 17:11:21+01:00
committergravatar for squeek502@hotmail.comRyan Liptak <squeek502@hotmail.com> 2025-11-08 00:34:41-08:00
log38d44404a589590e0443444f2206d7e9859b09fe
treea1ce856bb3c3908cebb926e491f7de0fc679c24e
parent74d2536715c4d4c27d7075b9675fa330e5be02cf

Fix param name in doc comment for std.Io.Reader.peek()

The old doc comment mentioned a parameter `len` three times, but the function does not accept such a parameter - it is actually called `n`.

1 files changed, 3 insertions(+), 3 deletions(-)

lib/std/Io/Reader.zig+3-3
......@@ -469,15 +469,15 @@ pub fn readVecAll(r: *Reader, data: [][]u8) Error!void {
469469 }
470470}
471471
472/// Returns the next `len` bytes from the stream, filling the buffer as
472/// Returns the next `n` bytes from the stream, filling the buffer as
473473/// necessary.
474474///
475475/// Invalidates previously returned values from `peek`.
476476///
477477/// Asserts that the `Reader` was initialized with a buffer capacity at
478/// least as big as `len`.
478/// least as big as `n`.
479479///
480/// If there are fewer than `len` bytes left in the stream, `error.EndOfStream`
480/// If there are fewer than `n` bytes left in the stream, `error.EndOfStream`
481481/// is returned instead.
482482///
483483/// See also: