Autoinduct documentation improvement #20
Open
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.
Many files in the autoinduct folder already have good documentation.
However, the general ReadMe misses an introduction like given in
ltac1
.A redirect to
ltac1
for motivation and ideas already helps.Furthermore, the MetaCoq part could use a bit more guidance on what the files are good for and how they are structured/how they operate.
This pull request extends the documentation and attempts to improve the points mentioned above.