fsharp / fsharp/fsharp-core-docs

Include type constraints in documentation

Open
#65 5 comments 0 reactions 0 assignees View on GitHub
fsdocs
Dominant language
No language data
Stars
37
Forks
20
Avg merge
6m
Merged PRs (30d)
1

Description

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?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.