Commit `38d44404a5`

Petr Pučil <petr.pucil@seznam.cz>

2025-11-06 17:11:21

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`.

master

1 parent 74d2536

Changed files (1)

lib

std

Reader.zig

@@ -469,15 +469,15 @@ pub fn readVecAll(r: *Reader, data: [][]u8) Error!void {
     }
 }
 
-/// Returns the next `len` bytes from the stream, filling the buffer as
+/// Returns the next `n` bytes from the stream, filling the buffer as
 /// necessary.
 ///
 /// Invalidates previously returned values from `peek`.
 ///
 /// Asserts that the `Reader` was initialized with a buffer capacity at
-/// least as big as `len`.
+/// least as big as `n`.
 ///
-/// If there are fewer than `len` bytes left in the stream, `error.EndOfStream`
+/// If there are fewer than `n` bytes left in the stream, `error.EndOfStream`
 /// is returned instead.
 ///
 /// See also:

Commit 38d44404a5

Commit `38d44404a5`