diff --git a/src/fsharp/FSharp.Core/seq.fsi b/src/fsharp/FSharp.Core/seq.fsi index 9a8b95eeede..d327172b4f6 100644 --- a/src/fsharp/FSharp.Core/seq.fsi +++ b/src/fsharp/FSharp.Core/seq.fsi @@ -253,6 +253,7 @@ namespace Microsoft.FSharp.Collections /// The sequence split into chunks. /// Thrown when the input sequence is null. /// Thrown when count is not positive. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val splitInto: count:int -> source:seq<'T> -> seq<'T[]> @@ -371,6 +372,7 @@ namespace Microsoft.FSharp.Collections /// Thrown if no element returns true when /// evaluated by the predicate /// Thrown when the input sequence is null + /// This function consumes the whole input sequence before returning the result. [] val findBack: predicate:('T -> bool) -> source:seq<'T> -> 'T @@ -396,6 +398,7 @@ namespace Microsoft.FSharp.Collections /// Thrown if no element returns true when /// evaluated by the predicate /// Thrown when the input sequence is null + /// This function consumes the whole input sequence before returning the result. [] val findIndexBack: predicate:('T -> bool) -> source:seq<'T> -> int @@ -435,6 +438,7 @@ namespace Microsoft.FSharp.Collections /// The initial state. /// The state object after the folding function is applied to each element of the sequence. /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before returning the result. [] val foldBack<'T,'State> : folder:('T -> 'State -> 'State) -> source:seq<'T> -> state:'State -> 'State @@ -699,6 +703,7 @@ namespace Microsoft.FSharp.Collections /// The input collection. /// Thrown when the input collection is null. /// The collection of transformed elements, and the final accumulated value. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val mapFold<'T,'State,'Result> : mapping:('State -> 'T -> 'Result * 'State) -> state:'State -> source:seq<'T> -> seq<'Result> * 'State @@ -711,6 +716,7 @@ namespace Microsoft.FSharp.Collections /// The initial state. /// Thrown when the input collection is null. /// The collection of transformed elements, and the final accumulated value. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val mapFoldBack<'T,'State,'Result> : mapping:('T -> 'State -> 'Result * 'State) -> source:seq<'T> -> state:'State -> seq<'Result> * 'State @@ -888,6 +894,7 @@ namespace Microsoft.FSharp.Collections /// /// Thrown when the input sequence is null. /// Thrown when indexMap does not produce a valid permutation. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val permute: indexMap:(int -> int) -> source:seq<'T> -> seq<'T> @@ -950,6 +957,7 @@ namespace Microsoft.FSharp.Collections /// The final result of the reductions. /// Thrown when the input sequence is null. /// Thrown when the input sequence is empty. + /// This function consumes the whole input sequence before returning the result. [] val reduceBack: reduction:('T -> 'T -> 'T) -> source:seq<'T> -> 'T @@ -957,6 +965,7 @@ namespace Microsoft.FSharp.Collections /// The input sequence. /// The reversed sequence. /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before yielding the first element of the reversed sequence. [] val rev: source:seq<'T> -> seq<'T> @@ -981,6 +990,7 @@ namespace Microsoft.FSharp.Collections /// The initial state. /// The resulting sequence of computed states. /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val scanBack<'T,'State> : folder:('T -> 'State -> 'State) -> source:seq<'T> -> state:'State -> seq<'State> @@ -1032,6 +1042,7 @@ namespace Microsoft.FSharp.Collections /// The result sequence. /// /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val sort : source:seq<'T> -> seq<'T> when 'T : comparison @@ -1045,6 +1056,7 @@ namespace Microsoft.FSharp.Collections /// The function to compare the collection elements. /// The input sequence. /// The result sequence. + /// This function consumes the whole input sequence before yielding the first element of the result sequence. [] val sortWith : comparer:('T -> 'T -> int) -> source:seq<'T> -> seq<'T> @@ -1208,6 +1220,7 @@ namespace Microsoft.FSharp.Collections /// The input sequence. /// The found element or None. /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before returning the result. [] val tryFindBack: predicate:('T -> bool) -> source:seq<'T> -> 'T option @@ -1240,6 +1253,7 @@ namespace Microsoft.FSharp.Collections /// The input sequence. /// The found index or None. /// Thrown when the input sequence is null. + /// This function consumes the whole input sequence before returning the result. [] val tryFindIndexBack : predicate:('T -> bool) -> source:seq<'T> -> int option