This repository was archived by the owner on Nov 26, 2024. It is now read-only.
Repository navigation
This repository was archived by the owner on Nov 26, 2024. It is now read-only.
New functions added to List, Array, Seq modules in F# 4.0 are missing Docs #184
Description
Many new functions were added in F# 4.0: https://github.com/fsharp/FSharpLangDesign/blob/master/FSharp-4.0/ListSeqArrayAdditions.md. Most of them do not have documentation yet.
Here's the list of functions that still need docs:
Total Remaining: 94
- List.contains
- Array.contains
- Seq.contains
- List.chunkBySize
- Array.chunkBySize
- Seq.chunkBySize
- List.compareWith
- Array.compareWith
- List.countBy
- Array.countBy
- List.distinct
- Array.distinct
- List.distinctBy
- Array.distinctBy
- List.splitInto
- Array.splitInto
- Seq.splitInto
- List.exactlyOne
- Array.exactlyOne
- List.except
- Array.except
- Seq.except
- List.findBack
- Array.findBack
- Seq.findBack
- List.findIndexBack
- Array.findIndexBack
- Seq.findIndexBack
- Seq.fold2
- Seq.foldBack
- Seq.foldBack2
- Seq.groupBy
- Array.head
- List.indexed
- Array.indexed
- Seq.indexed
- List.item
- Array.item
- Seq.item
- Seq.iteri2
- List.last
- Array.last
- Array.map3
- Seq.map3
- Seq.mapi2
- List.mapFold
- Array.mapFold
- Seq.mapFold
- List.mapFoldBack
- Array.mapFoldBack
- Seq.mapFoldBack
- List.pairwise
- Array.pairwise
- Seq.permute
- Seq.reduceBack
- Array.replicate
- Seq.replicate
- Seq.rev
- Seq.scanBack
- List.singleton
- Array.singleton
- List.skip
- Array.skip
- List.skipWhile
- Array.skipWhile
- Seq.sortWith
- List.sortDescending
- Array.sortDescending
- Seq.sortDescending
- List.sortByDescending
- Array.sortByDescending
- Seq.sortByDescending
- Array.tail
- Seq.tail
- List.take
- Array.take
- List.takeWhile
- Array.takeWhile
- List.truncate
- Array.truncate
- List.tryFindBack
- Array.tryFindBack
- Seq.tryFindBack
- List.tryFindIndexBack
- Array.tryFindIndexBack
- Seq.tryFindIndexBack
- List.tryHead
- Array.tryHead
- Seq.tryHead
- List.tryItem
- Array.tryItem
- Seq.tryItem
- List.tryLast
- Array.tryLast
- Seq.tryLast
- List.unfold
- Array.unfold
- List.where
- Array.where
- List.windowed
- Array.windowed
- List.splitAt
- Array.splitAt
Activity
cartermp commentedon Jun 22, 2016
Thanks for putting this table together Libo Zeng (@liboz)!
liboz commentedon Jun 22, 2016
Phillip Carter (@cartermp) I plan on making at least some of the docs that are missing. Should I make multiple pull requests (something like one for each group of functions, i.e. List.contains, Array.contains, Seq.contains) or one big pull request or is there some other method that would be preferred?
dend commentedon Jun 22, 2016
Libo Zeng (@liboz) as soon as you have a new article, issue a PR. Unless you have 7 ready at once, one-by-one is fine and we'll make sure to review and merge them properly.
eriawan commentedon Jun 30, 2016
Phillip Carter (@cartermp) Den (@dend)
I already create a PR #193 for this, especially for new APIs (functions) in the What's new in F# MD. Please review it guys :)
If you are OK with this, don't merge it yet. I'll continue to do the doc writings.
eriawan commentedon Jun 30, 2016
Maybe we could combine with the works from Libo Zeng (@liboz) :)
Add documentation fors List.distinctBy
Add documentation for Array.distinctBy
Add documentation for Array.distinctBy (#278)
Add documentation fors List.distinctBy (#277)
eriawan commentedon Mar 14, 2017
Libo Zeng (@liboz)
The list at the top needs to be updated, now we have accepted PR from Erik Schierboom (@ErikSchierboom)
This is the list of his pull requests for the updates:
cc Phillip Carter (@cartermp)
hickford commentedon May 23, 2018
Hi. Any progress? List.groupBy is missing documentation too at both https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/lists and https://msdn.microsoft.com/visualfsharpdocs/conceptual/collections.list-module-%5bfsharp%5d
hickford commentedon May 23, 2018
List.allPairs is also missing documentation #310
ScottHutchinson commentedon Sep 13, 2018
I will try to help with this, but it seems to me that the people who added the new functions should add the documentation too. They would know best exactly how the function works and how to use it, etc.
hickford commentedon Jan 29, 2021
Looks like most or even all these functions are now documented at
ScottHutchinson commentedon Jan 30, 2021
M Hickford (@hickford) That is only the bare minimum documentation generated from XML comments. There are no examples, for instance. That is inadequate.