Skip to content

Commit 38d4440

Browse files
generalmimonsqueek502
authored andcommitted
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 parent 74d2536 commit 38d4440

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/std/Io/Reader.zig

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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:

0 commit comments

Comments
 (0)