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

Type constructors should be included in doc generation #1313

Open
Izaakwltn opened this issue Oct 15, 2024 · 0 comments
Open

Type constructors should be included in doc generation #1313

Izaakwltn opened this issue Oct 15, 2024 · 0 comments
Labels

Comments

@Izaakwltn
Copy link
Collaborator

For instance:

https://coalton-lang.github.io/reference/#optional-type

https://coalton-lang.github.io/reference/#ord-type

https://coalton-lang.github.io/reference/#cell-type

For a new user, there's no way to tell what the constructors are unless they're listed in a tutorial or you go code-spelunking. How would you know that Result uses either Ok or Err?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant