diff --git a/docs/conceptual/list.exists2['t1,'t2]-function-[fsharp].md b/docs/conceptual/list.exists2['t1,'t2]-function-[fsharp].md index 85b797d7..a65af04c 100644 --- a/docs/conceptual/list.exists2['t1,'t2]-function-[fsharp].md +++ b/docs/conceptual/list.exists2['t1,'t2]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: 09474659-eff2-4903-bdbd-967f65f00f17 # List.exists2<'T1,'T2> Function (F#) -Tests if any pair of corresponding elements of the lists satisfies the given predicate. +Tests if any pair of corresponding elements of the lists satisfies the given predicate. The lists must have equal lengths. **Namespace/Module Path:** Microsoft.FSharp.Collections.List @@ -55,8 +55,14 @@ The second input list. `true` if any pair of elements satisfy the predicate. Otherwise, returns `false`. +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks -The predicate is applied to matching elements in the two collections up to the lesser of the two lengths of the collections. If any application returns true then the overall result is true and no further elements are tested. +The predicate is applied to matching elements in the two collections. If any application returns true then the overall result is true and no further elements are tested. This function is named `Exists2` in compiled assemblies. If you are accessing the function from a .NET language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.fold2['t1,'t2,'state]-function-[fsharp].md b/docs/conceptual/list.fold2['t1,'t2,'state]-function-[fsharp].md index ab63a150..9b66f5df 100644 --- a/docs/conceptual/list.fold2['t1,'t2,'state]-function-[fsharp].md +++ b/docs/conceptual/list.fold2['t1,'t2,'state]-function-[fsharp].md @@ -13,7 +13,8 @@ ms.assetid: 3c8edaf5-fbbb-4726-900e-b2423c54caf0 # List.fold2<'T1,'T2,'State> Function (F#) -Applies a function to corresponding elements of two collections, threading an accumulator argument through the computation. The collections must have identical sizes. If the input function is `f` and the elements are `i0...iN` and `j0...jN` then computes `f (... (f s i0 j0)...) iN jN`. +Applies a function to corresponding elements of two lists, threading an accumulator argument through the computation. The lists must have equal lengths. +If the input function is `f` and the elements are `i0...iN` and `j0...jN` then computes `f (... (f s i0 j0)...) iN jN`. **Namespace/Module Path:** Microsoft.FSharp.Collections.List @@ -58,16 +59,16 @@ Type: **'T2**[list](https://msdn.microsoft.com/library/c627b668-477b-4409-91ed-0 The second input list. +## Return Value + +The final state value. + ## Exceptions |Exception|Condition| |----|----| |[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| -## Return Value - -The final state value. - ## Remarks This function is named `Fold2` in compiled assemblies. If you are accessing the function from a .NET language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.foldback2['t1,'t2,'state]-function-[fsharp].md b/docs/conceptual/list.foldback2['t1,'t2,'state]-function-[fsharp].md index 05208467..570a861f 100644 --- a/docs/conceptual/list.foldback2['t1,'t2,'state]-function-[fsharp].md +++ b/docs/conceptual/list.foldback2['t1,'t2,'state]-function-[fsharp].md @@ -13,7 +13,8 @@ ms.assetid: 5b84c2a5-18db-44dc-9c5c-f83664672e45 # List.foldBack2<'T1,'T2,'State> Function (F#) -Applies a function to corresponding elements of two collections, threading an accumulator argument through the computation. The collections must have identical sizes. If the input function is `f` and the elements are `i0...iN` and `j0...jN`, then this function computes `f i0 j0 (...(f iN jN s))`. +Applies a function to corresponding elements of two lists, threading an accumulator argument through the computation. The lists must have equal lengths. +If the input function is `f` and the elements are `i0...iN` and `j0...jN`, then this function computes `f i0 j0 (...(f iN jN s))`. **Namespace/Module Path:** Microsoft.FSharp.Collections.List @@ -58,16 +59,15 @@ Type: **'State** The initial state. +## Return Value + +The final state value. ## Exceptions |Exception|Condition| |----|----| -|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the list is empty.| - -## Return Value - -The final state value. +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the lists differ in length.| ## Remarks This function is named `FoldBack2` in compiled assemblies. If you are accessing the function from a .NET language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.forall2['t1,'t2]-function-[fsharp].md b/docs/conceptual/list.forall2['t1,'t2]-function-[fsharp].md index 5c17da0b..dc686a96 100644 --- a/docs/conceptual/list.forall2['t1,'t2]-function-[fsharp].md +++ b/docs/conceptual/list.forall2['t1,'t2]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: a125b984-5e21-4dc4-9734-b0b796807401 # List.forall2<'T1,'T2> Function (F#) -Tests if all corresponding elements of the collection satisfy the given predicate pairwise. +Tests if all corresponding elements of the lists satisfy the given predicate pairwise. The lists must have equal lengths. **Namespace/Module Path:** Microsoft.FSharp.Collections.List diff --git a/docs/conceptual/list.iter2['t1,'t2]-function-[fsharp].md b/docs/conceptual/list.iter2['t1,'t2]-function-[fsharp].md index f1d4c930..c1ab7487 100644 --- a/docs/conceptual/list.iter2['t1,'t2]-function-[fsharp].md +++ b/docs/conceptual/list.iter2['t1,'t2]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: 54b3700b-9b7a-46be-8dba-fbdeef5b5353 # List.iter2<'T1,'T2> Function (F#) -Applies the given function to two collections simultaneously. The collections must have identical size. +Applies the given function to two lists simultaneously. The lists must have equal lengths. **Namespace/Module Path:** Microsoft.FSharp.Collections.List diff --git a/docs/conceptual/list.iteri2['t1,'t2]-function-[fsharp].md b/docs/conceptual/list.iteri2['t1,'t2]-function-[fsharp].md index 3f9adabe..4af1d9dd 100644 --- a/docs/conceptual/list.iteri2['t1,'t2]-function-[fsharp].md +++ b/docs/conceptual/list.iteri2['t1,'t2]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: 183c14eb-67b1-4550-a5ec-a417a61261a9 # List.iteri2<'T1,'T2> Function (F#) -Applies the given function to two collections simultaneously. The collections must have identical size. The integer passed to the function indicates the index of element. +Applies the given function to two lists simultaneously. The lists must have equal lengths. The integer passed to the function indicates the index of element. **Namespace/Module Path:** Microsoft.FSharp.Collections.List diff --git a/docs/conceptual/list.map2['t1,'t2,'u]-function-[fsharp].md b/docs/conceptual/list.map2['t1,'t2,'u]-function-[fsharp].md index 00ae7e60..23f9b644 100644 --- a/docs/conceptual/list.map2['t1,'t2,'u]-function-[fsharp].md +++ b/docs/conceptual/list.map2['t1,'t2,'u]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: aa680673-f521-47b3-bd42-29a526d93904 # List.map2<'T1,'T2,'U> Function (F#) -Creates a new collection whose elements are the results of applying the given function to the corresponding elements of the two collections pairwise. +Creates a new list whose elements are the results of applying the given function to the corresponding elements of the two lists pairwise. The lists must have equal lengths. **Namespace/Module Path:** Microsoft.FSharp.Collections.List @@ -55,6 +55,12 @@ The second input list. The list of resulting elements. +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks The two lists *list1* and *list2* must have the same length. If they don't, an exception is thrown. diff --git a/docs/conceptual/list.map3['t1,'t2,'t3,'u]-function-[fsharp].md b/docs/conceptual/list.map3['t1,'t2,'t3,'u]-function-[fsharp].md index c255aebb..bff6ac13 100644 --- a/docs/conceptual/list.map3['t1,'t2,'t3,'u]-function-[fsharp].md +++ b/docs/conceptual/list.map3['t1,'t2,'t3,'u]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: 4ebaa36f-1162-419f-ba5e-18f851a63c01 # List.map3<'T1,'T2,'T3,'U> Function (F#) -Creates a new collection whose elements are the results of applying the given function to the corresponding elements of the three collections simultaneously. +Creates a new list whose elements are the results of applying the given function to the corresponding elements of the three lists simultaneously. The lists must have equal lengths. **Namespace/Module Path**: Microsoft.FSharp.Collections.List @@ -60,9 +60,15 @@ The third input list. ## Return Value -he list of transformed elements. +The list of transformed elements. + +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks -The three lists *list1*, *list2*, and *list3* must all have the same length. If they don't, an exception is thrown. This function is named `Map3` in compiled assemblies. If you are accessing the function from a .NET language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.mapi2['t1,'t2,'u]-function-[fsharp].md b/docs/conceptual/list.mapi2['t1,'t2,'u]-function-[fsharp].md index 1c27493d..9f2bf713 100644 --- a/docs/conceptual/list.mapi2['t1,'t2,'u]-function-[fsharp].md +++ b/docs/conceptual/list.mapi2['t1,'t2,'u]-function-[fsharp].md @@ -13,7 +13,7 @@ ms.assetid: 18316575-2a76-4312-a934-818bebb4ae3a # List.mapi2<'T1,'T2,'U> Function (F#) -Like [`List.mapi`](https://msdn.microsoft.com/library/284b9234-3d26-409b-b328-ac79638d9e14), but mapping corresponding elements from two lists of equal length. +Like [`List.mapi`](https://msdn.microsoft.com/library/284b9234-3d26-409b-b328-ac79638d9e14), but mapping corresponding elements from two lists. The lists must have equal lengths. **Namespace/Module Path:** Microsoft.FSharp.Collections.List @@ -55,6 +55,12 @@ The second input list. The list of transformed elements. +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks This function is named `MapIndexed2` in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.zip3['t1,'t2,'t3]-function-[fsharp].md b/docs/conceptual/list.zip3['t1,'t2,'t3]-function-[fsharp].md index 304e6d26..28f931a9 100644 --- a/docs/conceptual/list.zip3['t1,'t2,'t3]-function-[fsharp].md +++ b/docs/conceptual/list.zip3['t1,'t2,'t3]-function-[fsharp].md @@ -55,6 +55,12 @@ The third input list. A single list containing triples of matching elements from the input lists. +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks This function is named `Zip3` in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name. diff --git a/docs/conceptual/list.zip['t1,'t2]-function-[fsharp].md b/docs/conceptual/list.zip['t1,'t2]-function-[fsharp].md index b9da0ea7..af7a5333 100644 --- a/docs/conceptual/list.zip['t1,'t2]-function-[fsharp].md +++ b/docs/conceptual/list.zip['t1,'t2]-function-[fsharp].md @@ -48,6 +48,12 @@ The second input list. A single list containing pairs of matching elements from the input lists. +## Exceptions + +|Exception|Condition| +|----|----| +|[ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx)|Thrown when the input lists differ in length.| + ## Remarks This function is named `Zip` in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.