From c08dea98c2c70db3576edd6655a9931393f6d052 Mon Sep 17 00:00:00 2001 From: tokayy Date: Fri, 17 Nov 2023 00:36:38 +1100 Subject: [PATCH 1/4] Fix List.chunkBySize documentation --- src/FSharp.Core/list.fsi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/FSharp.Core/list.fsi b/src/FSharp.Core/list.fsi index de20bb2e33f..f9be0d1c84f 100644 --- a/src/FSharp.Core/list.fsi +++ b/src/FSharp.Core/list.fsi @@ -206,7 +206,7 @@ module List = [] val choose: chooser:('T -> 'U option) -> list:'T list -> 'U list - /// Divides the input list into lists (chunks) with at a positive number of at most chunkSize elements. + /// Divides the input list into lists (chunks) of size at most chunkSize. /// Returns a new list containing the generated lists (chunks) as its elements. /// /// Returns an empty list when the input list is empty. From 52cbc3bb461e943e44c46d10f6bd74d304492f72 Mon Sep 17 00:00:00 2001 From: tokayy Date: Fri, 17 Nov 2023 00:39:26 +1100 Subject: [PATCH 2/4] Fix List.concat documentation --- src/FSharp.Core/list.fsi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/FSharp.Core/list.fsi b/src/FSharp.Core/list.fsi index f9be0d1c84f..e7a9fd582d2 100644 --- a/src/FSharp.Core/list.fsi +++ b/src/FSharp.Core/list.fsi @@ -339,7 +339,7 @@ module List = [] val inline compareWith: comparer:('T -> 'T -> int) -> list1:'T list -> list2:'T list -> int - /// Returns a new list that contains the elements of each the lists in order. + /// Returns a new list that contains the elements of each of the lists in order. /// /// The input sequence of lists. /// From 9fb8a824c94bbc8bc96fc33cf0afe6f763cf7846 Mon Sep 17 00:00:00 2001 From: tokayy Date: Fri, 17 Nov 2023 00:45:03 +1100 Subject: [PATCH 3/4] Fix minor grammatical errors in List module documentation --- src/FSharp.Core/list.fsi | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/FSharp.Core/list.fsi b/src/FSharp.Core/list.fsi index e7a9fd582d2..9cf9a07702c 100644 --- a/src/FSharp.Core/list.fsi +++ b/src/FSharp.Core/list.fsi @@ -243,7 +243,7 @@ module List = [] val chunkBySize: chunkSize:int -> list:'T list -> 'T list list - /// For each element of the list, applies the given function. Concatenates all the results and return the combined list. + /// For each element of the list, apply the given function. Concatenates all the results and return the combined list. /// /// The function to transform each input element into a sublist to be concatenated. /// The input list. @@ -1148,7 +1148,7 @@ module List = val inline iter: action:('T -> unit) -> list:'T list -> unit /// Applies the given function to two collections simultaneously. The - /// collections must have identical size. + /// collections must have identical sizes. /// /// The function to apply to pairs of elements from the input lists. /// The first input list. @@ -1173,7 +1173,7 @@ module List = val iter2: action:('T1 -> 'T2 -> unit) -> list1:'T1 list -> list2:'T2 list -> unit /// Applies the given function to each element of the collection. The integer passed to the - /// function indicates the index of element. + /// function indicates the index of the element. /// /// The function to apply to the elements of the list along with their index. /// The input list. @@ -1196,8 +1196,8 @@ module List = val inline iteri: action:(int -> 'T -> unit) -> list:'T list -> unit /// 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. + /// collections must have identical sizes. The integer passed to the + /// function indicates the index of the element. /// /// The function to apply to a pair of elements from the input lists along with their index. /// The first input list. @@ -1411,7 +1411,7 @@ module List = /// Builds a new collection whose elements are the results of applying the given function /// to each of the elements of the collection. The integer index passed to the - /// function indicates the index (from 0) of element being transformed. + /// function indicates the index (from 0) of the element being transformed. /// /// The function to transform elements and their indices. /// The input list. From 762071bd216925e7bb34e17c5cf766050a9f219e Mon Sep 17 00:00:00 2001 From: tokayy <142656361+tokayy@users.noreply.github.com> Date: Fri, 17 Nov 2023 22:31:38 +1100 Subject: [PATCH 4/4] Revert changes for List.collect summary Co-authored-by: Adam Boniecki <20281641+abonie@users.noreply.github.com> --- src/FSharp.Core/list.fsi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/FSharp.Core/list.fsi b/src/FSharp.Core/list.fsi index 9cf9a07702c..d746198f7fb 100644 --- a/src/FSharp.Core/list.fsi +++ b/src/FSharp.Core/list.fsi @@ -243,7 +243,7 @@ module List = [] val chunkBySize: chunkSize:int -> list:'T list -> 'T list list - /// For each element of the list, apply the given function. Concatenates all the results and return the combined list. + /// For each element of the list, applies the given function. Concatenates all the results and returns the combined list. /// /// The function to transform each input element into a sublist to be concatenated. /// The input list.