authorgravatar for 87334103+axlEscalada@users.noreply.github.comaxel escalada <87334103+axlEscalada@users.noreply.github.com> 2025-01-04 10:45:12-03:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2025-01-04 13:45:12+00:00
logff4f2753e4eb1226c1b18a812ee6ff5ca914fe85
treec15de9209027a5290367e85ca4ba5828b931b05f
parentb4da8eef2a393543e9520c544364689ab482b080
signaturebadge-check Signed by PGP key B5690EEEBB952194

Improve `first()` documentation for split iterators

* remove from doc., add explicit info when panic * match convention for assert documentation, avoiding to use panic here

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

lib/std/mem.zig+6-3
......@@ -2903,9 +2903,10 @@ pub fn WindowIterator(comptime T: type) type {
29032903
29042904 const Self = @This();
29052905
2906 /// Returns a slice of the first window. This never fails.
2906 /// Returns a slice of the first window.
29072907 /// Call this only to get the first window and then use `next` to get
29082908 /// all subsequent windows.
2909 /// Asserts that iteration has not begun.
29092910 pub fn first(self: *Self) []const T {
29102911 assert(self.index.? == 0);
29112912 return self.next().?;
......@@ -3037,8 +3038,9 @@ pub fn SplitIterator(comptime T: type, comptime delimiter_type: DelimiterType) t
30373038
30383039 const Self = @This();
30393040
3040 /// Returns a slice of the first field. This never fails.
3041 /// Returns a slice of the first field.
30413042 /// Call this only to get the first field and then use `next` to get all subsequent fields.
3043 /// Asserts that iteration has not begun.
30423044 pub fn first(self: *Self) []const T {
30433045 assert(self.index.? == 0);
30443046 return self.next().?;
......@@ -3101,8 +3103,9 @@ pub fn SplitBackwardsIterator(comptime T: type, comptime delimiter_type: Delimit
31013103
31023104 const Self = @This();
31033105
3104 /// Returns a slice of the first field. This never fails.
3106 /// Returns a slice of the first field.
31053107 /// Call this only to get the first field and then use `next` to get all subsequent fields.
3108 /// Asserts that iteration has not begun.
31063109 pub fn first(self: *Self) []const T {
31073110 assert(self.index.? == self.buffer.len);
31083111 return self.next().?;