fsharp / fsharp/fsharp-core-docs

Include type constraints in documentation

Offen
#65 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
fsdocs
Vorherrschende Sprache
Keine Sprachdaten
Sterne
37
Forks
20
Ø Merge
6 Min.
Gemergte PRs (30 T.)
1

Beschreibung

The [documentation for `hash`](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#hash) does not say that it requires the `equality` constraint on its only type parameter. Another example is the [documentation for `compare`](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#compare). It requires the `comparison` type constraint on its only type parameter. For convenience, here is the [list of all type constraints](https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/generics/constraints).

Could type constraints be added to the documentation for types that have them?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.