Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include type constraints in documentation #65

Open
TysonMN opened this issue Aug 14, 2020 · 5 comments
Open

Include type constraints in documentation #65

TysonMN opened this issue Aug 14, 2020 · 5 comments
Labels
fsdocs This is really an issue in FSharp.Formatting

Comments

@TysonMN
Copy link

TysonMN commented Aug 14, 2020

The documentation for hash does not say that it requires the equality constraint on its only type parameter. Another example is the documentation for compare. It requires the comparison type constraint on its only type parameter. For convenience, here is the list of all type constraints.

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

@cartermp
Copy link
Member

This would have to be a feature in FSharp.Formatting: https://github.com/fsprojects/FSharp.Formatting

@dsyme dsyme added the fsdocs This is really an issue in FSharp.Formatting label Aug 14, 2020
@TysonMN
Copy link
Author

TysonMN commented Aug 15, 2020

Should I create an issue there?

@cartermp
Copy link
Member

That'd be grand!

@TysonMN
Copy link
Author

TysonMN commented Aug 15, 2020

Done. See fsprojects/FSharp.Formatting#591.

@TysonMN TysonMN closed this as completed Aug 15, 2020
@dsyme
Copy link
Contributor

dsyme commented Aug 16, 2020

@bender2k14 I'll keep this one open for tracking

@dsyme dsyme reopened this Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fsdocs This is really an issue in FSharp.Formatting
Projects
None yet
Development

No branches or pull requests

3 participants