mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 13:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

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

Browse source 
The old doc comment mentioned a parameter `len` three times, but the
function does not accept such a parameter - it is actually called `n`.
This commit is contained in:
Petr Pučil 2025-11-06 17:11:21 +01:00 • committed by Ryan Liptak
parent 74d2536715
commit 38d44404a5
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/std/Io/Reader.zig
View file

@ -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. /// necessary.
/// ///
/// Invalidates previously returned values from `peek`. /// Invalidates previously returned values from `peek`.
/// ///
/// Asserts that the `Reader` was initialized with a buffer capacity at /// 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. /// is returned instead.
/// ///
/// See also: /// See also: