`Tracking` - Docs - code examples for all members, functions and types in FSharp.Core

dsyme commented 3 years ago

This is a tracking issue for adding code examples for all functions, members and types in FSharp.Core.

An example of the kind of thing that needs to be added is here: https://github.com/dotnet/fsharp/blob/main/src/fsharp/FSharp.Core/option.fsi#L136-L142.
Once integrated, your examples will appear in the F# core library docs here https://fsharp.github.io/fsharp-core-docs/

Modules and types to do:

[ ] FSharp.Core.Operators (mostly done in https://github.com/dotnet/fsharp/pull/12211)
[x] FSharp.Core.String
[x] FSharp.Core.Printf
[x] FSharp.Core.Result
[x] FSharp.Collections.Option
[x] FSharp.Collections.ValueOption
[x] FSharp.Collections.List
[x] FSharp.Collections.Array
[x] FSharp.Collections.Array.Parallel
[x] FSharp.Collections.Seq
[x] FSharp.Collections.Map (module)
[x] FSharp.Collections.Map (type)
[x] FSharp.Collections.Set
[x] FSharp.Collections.Array2D
[x] FSharp.Collections.Array3D
[x] FSharp.Collections.Array4D
[x] FSharp.Collections.HashIdentity
[x] FSharp.Collections.ComparisonIdentity
[ ] FSharp.Control.Async
[ ] FSharp.Control.Async.CommonExtensions
[x] FSharp.Control.Async.WebExtensions
[ ] FSharp.Control.Event
[x] FSharp.Control.Observable
[ ] FSharp.Control.Task
[x] FSharp.Quotations (started https://github.com/dotnet/fsharp/pull/12233)
[ ] FSharp.Quotations.BasicPatterns (started https://github.com/dotnet/fsharp/pull/12233)
[x] FSharp.Quotations.DerivedPatterns (started https://github.com/dotnet/fsharp/pull/12233)
[ ] FSharp.Reflection.FSharpType
[ ] FSharp.Reflection.FSharpValue
[x] FSharp.Core.ExtraTopLevelOperators

leolorenzoluis commented 2 years ago

@dsyme Please review my PR https://github.com/dotnet/fsharp/pull/12644 when you get a chance :)

dsyme commented 2 years ago

Great to see more progress on this!

dsyme commented 2 years ago

Great to see Observable be completed! Not that many more to go :)

dotnet / fsharp