From 2f9d5cc454477deeea5f98d5e550be07fc1770c5 Mon Sep 17 00:00:00 2001 From: zacoons Date: Fri, 9 Oct 2026 14:59:36 +1000 Subject: [PATCH] std.Io.Reader: Add clarification to streamDelimiterEnding doc comment --- lib/std/Io/Reader.zig | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/std/Io/Reader.zig b/lib/std/Io/Reader.zig index c8797f26c68bdc41778f6360d75e591c78e10396..f9d92824485c67d4aedef03b3fe34fe14fbd99d0 100644 --- a/lib/std/Io/Reader.zig +++ b/lib/std/Io/Reader.zig @@ -957,8 +957,8 @@ pub fn peekDelimiterExclusive(r: *Reader, delimiter: u8) DelimiterError![]u8 { return result[0 .. result.len - 1]; } -/// Appends to `w` contents by reading from the stream until `delimiter` is -/// found. Does not write the delimiter itself. +/// Appends to `w` contents by reading from the stream until `delimiter` is found. +/// Does not write the delimiter itself. /// /// Does not discard the delimiter from the `Reader`. /// @@ -983,6 +983,8 @@ pub fn streamDelimiter(r: *Reader, w: *Writer, delimiter: u8) StreamError!usize /// Appends to `w` contents by reading from the stream until `delimiter` is found. /// Does not write the delimiter itself. /// +/// Does not discard the delimiter from the `Reader`. +/// /// Returns number of bytes streamed, which may be zero. If the stream reaches /// the end, the reader buffer will be empty when this function returns. /// Otherwise, it will have at least one byte buffered, starting with the -- 2.54.0