Document alternative type declaration syntax #4882
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the introduction to syntax for declaring data types, document the ability
to declare types via constructor signatures in addition to the Haskell-like
syntax.
This syntax seems to be documented nowhere (not even in the book), and
is just used without explanation when introducing dependent types like
Fin
that require it. From personal experience, this is extremely confusingto newcomers to Idris.
(I'm not sure if this is the best place to document it, but it needs to be
somewhere where it will be easily found, and this is what comes up for
a Google search for "idris data types".)