dotnet / dotnet/fsharp

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

Open
#12,124 53 comments 12 reactions 0 assignees View on GitHub
Feature Improvement Theme-Simple-F# Tracking
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 11h
Merged PRs (30d)
131

Description

Related to https://twitter.com/dsymetweets/status/1435311963781861376

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](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule.html)
* [x] [FSharp.Collections.Array](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-arraymodule.html)
* [x] FSharp.Collections.Array.Parallel
* [x] [FSharp.Collections.Seq](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-seqmodule.html)
* [x] [FSharp.Collections.Map](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-mapmodule.html) (module)
* [x] [FSharp.Collections.Map](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-fsharpmap-2.html) (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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.