mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-13 12:59:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve first() documentation for split iterators

Browse Source 
* remove  from doc., add explicit info when panic

* match convention for assert documentation, avoiding to use panic here
This commit is contained in:
axel escalada 2025-01-04 10:45:12 -03:00 committed by GitHub
parent b4da8eef2a
commit ff4f2753e4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/std/mem.zig
View File

@ -2903,9 +2903,10 @@ pub fn WindowIterator(comptime T: type) type {
const Self = @This();
/// Returns a slice of the first window. This never fails.
/// Returns a slice of the first window.
/// Call this only to get the first window and then use `next` to get
/// all subsequent windows.
/// Asserts that iteration has not begun.
pub fn first(self: *Self) []const T {
assert(self.index.? == 0);
return self.next().?;
@ -3037,8 +3038,9 @@ pub fn SplitIterator(comptime T: type, comptime delimiter_type: DelimiterType) t
const Self = @This();
/// Returns a slice of the first field. This never fails.
/// Returns a slice of the first field.
/// Call this only to get the first field and then use `next` to get all subsequent fields.
/// Asserts that iteration has not begun.
pub fn first(self: *Self) []const T {
assert(self.index.? == 0);
return self.next().?;
@ -3101,8 +3103,9 @@ pub fn SplitBackwardsIterator(comptime T: type, comptime delimiter_type: Delimit
const Self = @This();
/// Returns a slice of the first field. This never fails.
/// Returns a slice of the first field.
/// Call this only to get the first field and then use `next` to get all subsequent fields.
/// Asserts that iteration has not begun.
pub fn first(self: *Self) []const T {
assert(self.index.? == self.buffer.len);
return self.next().?;