Skip to content

Commit 0cc0ec7

Browse files
Clarify docs for collapseRepeats{Len}.
Makes it clear what only passed element will be deduplicated.
1 parent c7f9550 commit 0cc0ec7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

lib/std/mem.zig

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4103,7 +4103,9 @@ pub fn replaceScalar(comptime T: type, slice: []T, match: T, replacement: T) voi
41034103
}
41044104
}
41054105

4106-
/// Collapse consecutive duplicate elements into one entry.
4106+
/// Collapse all consecutive occurrences of `elem` into one entry.
4107+
///
4108+
/// See also `collapseRepeatsAll`
41074109
pub fn collapseRepeatsLen(comptime T: type, slice: []T, elem: T) usize {
41084110
if (slice.len == 0) return 0;
41094111
var write_idx: usize = 1;
@@ -4117,7 +4119,9 @@ pub fn collapseRepeatsLen(comptime T: type, slice: []T, elem: T) usize {
41174119
return write_idx;
41184120
}
41194121

4120-
/// Collapse consecutive duplicate elements into one entry.
4122+
/// Collapse all consecutive occurrences of `elem` into one entry.
4123+
///
4124+
/// See also `collapseRepeatsAll`
41214125
pub fn collapseRepeats(comptime T: type, slice: []T, elem: T) []T {
41224126
return slice[0..collapseRepeatsLen(T, slice, elem)];
41234127
}

0 commit comments

Comments
 (0)