mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-30 15:10:46 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve docs for endsWith.

Browse source 
Fix typo in docs for startsWith.
This commit is contained in:
H. S. Teoh 2015-01-08 12:43:18 -08:00
parent ce45858a8a
commit 1b04b3433a
1 changed files with 23 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

26
std/algorithm.d
View file

@ -6923,9 +6923,10 @@ Params:
Returns: Returns:
0 if (none of) the needle(s) occur at the beginning of the given range; 0 if the needle(s) do not occur at the beginning of the given range;
otherwise the position of the matching needle, that is, 1 if it starts with $(D otherwise the position of the matching needle, that is, 1 if the range starts
withOneOfThese[0]), 2 if it starts with $(D withOneOfThese[1]), and so on. with $(D withOneOfThese[0]), 2 if it starts with $(D withOneOfThese[1]), and so
on.
In the case where $(D doesThisStart) starts with multiple of the ranges or In the case where $(D doesThisStart) starts with multiple of the ranges or
elements in $(D withOneOfThese), then the shortest one matches (if there are elements in $(D withOneOfThese), then the shortest one matches (if there are
@ -7316,7 +7317,26 @@ void skipAll(alias pred = "a == b", R, Es...)(ref R r, Es es)
} }
/** /**
Checks if the given range ends with (one of) the given needle(s).
The reciprocal of $(D startsWith). The reciprocal of $(D startsWith).
Params:
pred = The predicate to use for comparing elements between the range and
the needle(s).
doesThisEnd = The $(XREF2 range, isBidirectionalRange, bidirectional range)
to check.
withOneOfThese = The needles to check against, which may be single
elements, or bidirectional ranges of elements.
withThis = The single element to check.
Returns:
0 if the needle(s) do not occur at the end of the given range;
otherwise the position of the matching needle, that is, 1 if the range ends
with $(D withOneOfThese[0]), 2 if it ends with $(D withOneOfThese[1]), and so
on.
*/ */
uint endsWith(alias pred = "a == b", Range, Needles...)(Range doesThisEnd, Needles withOneOfThese) uint endsWith(alias pred = "a == b", Range, Needles...)(Range doesThisEnd, Needles withOneOfThese)
if (isBidirectionalRange!Range && Needles.length > 1 && if (isBidirectionalRange!Range && Needles.length > 1 &&